Retrieve campaign mileage data grouped by ad group

get

https://dashboard.streetmetrics.io/v3/public/reporting/mileage/ad-group

Transit ad groups only. summaryBin: LIFETIME, DAY, WEEK, MONTH, HOUR, DOW. Date range must fall within campaign flight bounds: use activeFrom/activeTo from GET /campaigns/{id}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

marketId

number

The ID of the market

startDate

number

required

Start of the query window as Unix seconds. Must be >= the earliest flight activeFrom for the campaign (same value as campaign.activeFrom from GET /campaigns/{id}). Do not use calendar-date midnight in an arbitrary timezone — that often falls before flight bounds and returns 400 "Requested start date is before the range of the flights".

endDate

number

required

End of the query window as Unix seconds. Must be <= the latest flight activeTo for the campaign (same value as campaign.activeTo from GET /campaigns/{id}). Prefer those campaign fields over reconstructing dates from labels or calendars.

campaignId

number

required

The ID of the campaign

summaryBin

string

enum

required

Summary bin: LIFETIME, DAY, WEEK, MONTH, HOUR, DOW.

Allowed:

timezone

string

Timezone for date calculations

units

string

enum

Distance units for the response. Overrides account preference when set. Default: account metadata, else miles (mi).

Allowed:

Responses

204

No mileage found

400

Bad request (e.g. startDate/endDate outside flight activeFrom–activeTo, invalid campaignId, invalid units)

401

Unauthorized

200Mileage data retrieved successfully (or not applicable for stationary inventory)

429Too Many Requests

500Internal Server Error