Skip to main content
POST
Entity Reporting
The main reporting endpoint for advertisers. Pivot your performance data by up to 10 dimensions over a date range. Returns table data, time-series performance, and an aggregated summary. Data is automatically scoped to the authenticated advertiser — no advertiser filter is needed. The API key determines which advertiser’s data is returned. Maximum reporting interval is one year (365 days). Results are limited to 10,000 rows. To stay under the limit, use query.metric_filters to drop rows below a threshold — for example, filter to rows with cost by adding { "metric_type": "revenue", "operator": "greater_than", "metric_value": 0 } (an advertiser’s cost is the revenue metric).

Authorizations

X-Eflow-Api-Key
string
header
required

The advertiser's API key generated from the Advertiser Portal. Uses the same X-Eflow-Api-Key header as other Everflow APIs, but the key belongs to the advertiser user rather than the network admin.

Body

application/json
from
string
required

Start date for the reporting period. Format YYYY-MM-DD.

to
string
required

End date for the reporting period. Format YYYY-MM-DD.

timezone_id
integer
required

Timezone identifier for the request.

currency_id
string
required

Currency code for monetary values (e.g. "USD").

columns
object[]
required

Columns to group/pivot data by. Minimum 1, maximum 10. Only one time column (hour, date, week, month, year) is allowed per request.

Required array length: 1 - 10 elements
query
object

Query configuration for filtering, metric filtering, and exclusions.

Response

200 - application/json
table
object[]

Array of reporting data rows grouped by the requested columns.

performance
object[]

Time-series performance data points.

summary
object

Aggregated summary across all rows. A flat object with the same metric keys as ReportingMetrics.