API Reference

Create an async report

post
https://api.vibe.co/reports

Creates an asynchronous report and returns the report resource. Poll GET /reports/{report_id} until the report reaches a terminal state. Scopes: reporting:read
Rate limits:
Burst: 1/s
Steady: 20/m

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

Minimum date (inclusive) for which to return data

date
required

Maximum date (exclusive) for which to return data

string
enum
Defaults to UTC

Timezone identifier for reported data

advertiser_ids
array of uuids
required
length ≥ 1

Advertisers to include. Must be owned by the tenant.

advertiser_ids*
dimensions
array of strings

Dimensions to group rows by

dimensions
metrics
array of strings
required
length ≥ 1

Metrics to compute

metrics*
string
enum
Defaults to 7 days
string
enum
Defaults to DAY

Time aggregation granularity for rows in the report

Allowed:
filters
array of objects

Optional filters, combined with AND

filters
string
enum
Defaults to JSON
Allowed:
Responses

Updated about 2 months ago

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

Updated about 2 months ago