API

Run a reporting query (GET)

Validates the API key, resolves the advertiser, and executes a reporting query. Prefer POST /apidata when sending a large filter object.

get/apidata

Request

Query parameters

keystring required

Advertiser API key (required on every request).

datastring required

Column selection: comma-separated identifiers or a JSON array string whose elements use the same shapes as POST /apidata data. Use GET /apilist to discover valid column identifiers (for data, sum, and filter).

sumstring[]
filterFilter

Optional JSON object that restricts which rows are returned. Use the same shape for POST filter and GET filter (URL-encoded).

Filter types — column predicates: Each property key is a column identifier (table.column). The value can be:

  • Operator object: keys are operator names and values are comparison values (for example {"equals": "Live"}, {"in": ["a","b"]}).
  • Scalar (string or number): shorthand for equals.
  • Array: shorthand for membership (in).

Filter types — logical groups: Properties named AND, OR, or NOT hold a nested object that follows the same rules (more column predicates and/or nested AND / OR / NOT).

Operator keys (allowed keys inside an operator object): equals, not, in, notIn, lt, lte, gt, gte, contains, notContains, startsWith, endsWith, hasAny.

Use GET /apilist to discover valid column identifiers (for data, sum, and filter).

beginstring required

start date of the query

endstring

end date of the query

format'human' | 'json' | 'csv' | 'excel'

defines the content type of the response

formatdataboolean

when set to true, the values in the response data will be each be formatted

fullnameboolean
limitinteger

when set, the number of rows returned will be limited to this number

offsetinteger

when set, the query will skip this number of rows. Used for pagination

sortstring[]

when set, data will be returned sorted by this column and direction

idsinteger[]
accountTypesinteger[]
{
  "key": "YOUR_API_KEY",
  "data": "graph.day,graph.impressions",
  "sum": [
    "campaigninfo.name"
  ],
  "begin": "2020-01-01",
  "end": "2023-12-31",
  "formatdata": true,
  "limit": 50,
  "offset": 50,
  "sort": [
    "impressions desc"
  ]
}

Response

Report data in the requested format

report-namestring

Name of the report

publisher-namestring

Name of the advertiser or 'Grouped Advertisers'

beginstring

Start date/time of the data range

endstring

End date/time of the data range

rowsobject[]

Array of data rows, each containing column name-value pairs

Example response

{
  "report-name": "Report",
  "publisher-name": "Example Advertiser",
  "begin": "2025-07-01T00:00:00",
  "end": "2025-08-15T23:59:59",
  "columns": [
    {
      "table": "inventory",
      "name": "day",
      "friendly": "Day",
      "alias": "Day",
      "help": "The date of the data",
      "format": "date",
      "icon": "calendar"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.