Skip to main content
GET
Retrieve Geographic Summary Stats

Authorizations

Authorization
string
header
required

API key en el header Authorization: Basic TU_API_KEY. La key va tal cual, sin codificar en base64. Las credenciales se entregan al comenzar la integración.

Query Parameters

type
string
required

Specifies the focus of the statistics you are interested in viewing. The value must be one of overview, publisher, advertiser, zone, campaign, or ad-item.

preset
string

Frequently used time frames for reporting statistics are bundled as "presets". You can pick a value from the presets instead of creating your own custom date range using the from and to fields. A preset range value must be one of the following: today, last-24-hours, yesterday, this-week, last-week, this-month, last-month, year-to-date, last-year, last-7-days, last-14-days, last-30-days, last-3-months, last-6-months, or last-12-months.

Either a preset or a valid to and from must be specified.

timezone
string

Timezone for the preset field (e.g. America/Los_Angeles). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

from
string<date-time>

A valid ISO 8601 formatted date denoting the inclusive start of the period. For example: 2020-01-01T00:00:00+00:00 (greater than or equal to). This field along with the to field lets you specify a custom date and time interval if no preset options suit your needs. The timezone offsets must match in the specified from and to fields.

You may not run a report for an interval larger than a year.

Either a preset or a valid to and from must be specified.

to
string<date-time>

A valid ISO 8601 formatted date denoting the exclusive end of the period. For example: 2020-02-01T00:00:00+00:00. This field along with the from field lets you specify a custom date and time interval if no preset options suit your needs. The timezone offsets must match the specified to and from fields.

You cannot run a report for an interval larger than a year.

Either a preset or a valid to and from must be specified.

publishers
string

Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.

zones
string

Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.

advertisers
string

Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.

campaigns
string

Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list.

ad-items
string

Submit this parameter to filter your report by a list of ad item IDs. The IDs must be submitted as a comma-separated list.

textads
string

Submit this parameter to filter your report by a list of text ad IDs. The IDs must be submitted as a comma-separated list.

popups
string

Submit this parameter to filter your report by a list of popup IDs. The IDs must be submitted as a comma-separated list.

Response

default - application/json

successful operation

data
object[]
meta
object
object
string

A string denoting the current resource being requested or affected.

Example:

"geo_summary_report"

url
string

The URL of the current resource.

Example:

"/v2/reports/geo-summary-report"