Sign in

v1

latestOpenAPI 3.1.02026-07-2414059.5 KB

/reporting/goals

post/reporting/goals

Headers

Authorizationstring required

This should be an API Key with the Advertiser scope

X-Api-Versionstring

Request body

game_idinteger required

Game to pull goals for

start_datetimestring date required

Pull goals triggered after this time (inclusive)

end_datetimestring date required

Pull goals triggered before this time (exclusive)

goal_type_idsinteger[]

Restrict the results to the provided goal types

trigger_typesstring[]

Restrict the results to the provided trigger types (standard, assist, contribution)

unattributedboolean

Restrict the results to only include unattributed (True), attributed (False), or all (Null)

limitinteger

Limit the number of results per page. Max 1,000,000 results per page

afterstring

Pull the page starting with this page token

Response

200

Example response

{
  "goals": [
    {
      "event_country": "US",
      "event_id": "1ec20fd8-28ba-664e-8ecf-9801a795bcd3",
      "event_os": "Windows 7 Service Pack 1",
      "event_platform": "xbox",
      "event_region": "ZZZ",
      "event_type": "game_launch",
      "game_id": 1,
      "goal_type_id": 1,
      "id": "1ec20fd8-28ba-6450-8ecf-9801a795bcd3",
      "record_updated_at": "2021-09-29T08:16:14",
      "revenue_currency": "USD",
      "revenue_type": "cumulative",
      "touchpoint_ad_group": "myadgroup",
      "touchpoint_browser_family": "Chrome",
      "touchpoint_campaign": "1",
      "touchpoint_cost_amount": 1,
      "touchpoint_cost_currency": "USD",
      "touchpoint_cost_model": "cpc",
      "touchpoint_country": "US",
      "touchpoint_destination_url": "https://store.steampowered.com",
      "touchpoint_device_brand": "Apple",
      "touchpoint_device_family": "Mac",
      "touchpoint_device_model": "Mac",
      "touchpoint_id": "1ec20fd8-288c-6078-8ecf-9801a795bcd3",
      "touchpoint_os_family": "Mac OS X",
      "touchpoint_os_major": "10",
      "touchpoint_region": "ZZZ",
      "touchpoint_request_url": "http://gsght.com/c/xxxxx?ad_group=myadgroup",
      "touchpoint_requested_at": "2021-09-26T08:16:12",
      "touchpoint_session_id": "1ec20fd8-288c-61cc-8ecf-9801a795bcd3",
      "touchpoint_team_id": 4,
      "touchpoint_type": "click",
      "touchpoint_unique": 1,
      "touchpoint_useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36",
      "trigger_id": "5.standard",
      "trigger_type": "standard",
      "triggered_at": "2021-09-29T08:16:12",
      "user_id": "12345-abcdef-6789",
      "value": 100
    }
  ],
  "paging": {
    "after": "xxxxxxxxxxx"
  }
}