POST /v2/observability/query
Servers
- https://api.vercel.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
metric |
String | Yes |
Metric id |
bucketTimezone |
String | No |
IANA timezone (e.g. Europe/Paris) used only to align calendar buckets (1d/1mo) to that zone's day/month boundaries. startTime/endTime and all output timestamps are always UTC. No effect on sub-day granularities. |
startTime |
String | No |
Start timestamp |
limit |
Number | No |
Maximum number of results |
filter |
String | No |
Filter to apply to the query. JSON dimensions support nested refs, for example event_data/checkout_step eq 'payment'. Nested keys containing characters that OData cannot parse as an identifier, such as '-', spaces, quotes, or '/', must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/'enable-comments-view' eq true or event_data/'some property''s/value' eq true. |
groupBy[] |
Array | No |
Dimensions to group results by. JSON dimensions support nested refs, for example event_data/checkout_step. Nested keys containing characters that OData cannot parse as an identifier, such as '-', spaces, quotes, or '/', must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/'enable-comments-view' or event_data/'some property''s/value'. |
orderBy |
String | No |
Rollup column to order grouped results by. Use the generated rollup key for the requested metric and aggregation. Defaults to the query engine count rollup. |
scope |
Object | Yes |
Owner or project scope for the query |
granularity |
Object | No |
Time bucket size |
orderDirection |
String | No |
Direction to order grouped results by. Defaults to desc. Valid values:
|
endTime |
String | No |
End timestamp |
aggregation |
String | No |
Aggregation function to apply. Some aggregations require a dimension: use /, for example unique/visitor_id. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.