Discard
GuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceChangelogDiscussionsLog In

[Statistics] Report Request Format

Creating a Report Request

A complete stats request requires the following fields:

Parameter

Definition

Type

Required?

advertiserIds

A list of advertiser ids (comma separated)

string

N

currency

The currency to be used in the report, ISO format.

A list of supported currencies is available here.

string

Y

startDate

Start date, ISO 8601 format.

string

Y

endDate

End date, ISO 8601 format.

string

Y

format

The output format. CSV, JSON, XML or EXCEL.

string

Y

dimensions

See the Dimensions page.

Array[string]

Y

metrics

See the Metrics page.

Array[string]

Y

timezone

The timezone for organizing the data in the report.

A list of supported values is available here.

string

N

UTC will be default timezone if not specified.

 

🚧

A Note on AdvertiserIds

Advertisers which are not in your portfolio will be skipped. The specified advertisers must have at least one campaign to appear in the report.

If you do not specify any value for advertiserIds, stats for all advertisers in your portfolio will be returned.


What’s Next

Learn about Dimensions for your report request

Did this page help you?