API Reference

Queue an asynchronous export of clicks for a date range, supplied in the request body.

post
https://platform.routy.app/api/v1/clicks/export

POST variant of M:Router.Api.Controllers.ClickController.OnGetExportClicks(Platform.Models.Clicks.Exports.ExportClicksRequest,System.Threading.CancellationToken). Requires the ListAccount policy. Creates
an export job and returns its descriptor (including a downloadUri). Output format is taken
from format (CSV, JSON or Parquet; defaults to CSV).

🔐 Required permission: accounts.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Date range, output format and optional completion callback URL.

date-time

The date range to export clicks from

date-time

the date to export clicks to

uri | null

a callback url to notify when the export is completed

string | null

Format of the export file. CSV, JSON or Parquet

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago