Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Required?

Description

Example

startDate

Required

Start date of the data

"2020-03-01"

endDate

Required

End date of the data

"2020-03-01"

publishers

Required

Publishers you wish to pull data for

["publisherKey1", "publisherKey2"]

fields

Required

Metric fields you wish to pull

["wins", "clicks"]

groupBy

Optional

Add in case you wish to group your data by any dimensions listed.

["publisher_name", "site_name"] 

filterBy

Optional. If specified a value of no more than 3 filterBy objects as  defined by separate table below

Add in case you wish to filter your data by any dimensions listed below (up to 3)

[ {field: ”publisher"publisher_name”name", value: “Test Pub”"Test Pub", operator: "EQUALS"}, {field: “site"site_name”name", value: “Some site name”"Some site name", operator: "NOT_EQUALS"} ]

timezone

Optional

Must be a valid IANA timezone. If not specified, results are returned by UTC timezone.

(list here)

"America/Chicago"

debug

Optional

Requests also return timestamp and a query ID that can be shared with Sharethrough for debugging purposes

"debug": true

...