Gamesight Reporting API
The Reporting API from Gamesight — 9 operation(s) for reporting.
OpenAPI Specification
openapi: 3.1.0
info:
title: Gamesight Measurement Reporting API
version: 1.1.0
description: The Gamesight Measurement API ingests a stream of in-game event data with device-level identifiers to power marketing attribution and measurement for PC, console, and web games. Send single events to /events or batches to /events/batch, and manage per-game do-not-track (GDPR/CCPA opt-out) state.
contact:
name: Gamesight Support
email: support@gamesight.io
url: https://docs.gamesight.io/
x-apisjson-source: https://docs.gamesight.io/reference (ReadMe embedded OpenAPI blocks)
servers:
- url: https://api.ingest.marketing.gamesight.io
security:
- ApiKeyAuth: []
tags:
- name: Reporting
paths:
/stats:
post:
summary: /stats
description: ''
operationId: stats-v3
parameters:
- name: Authorization
in: header
description: This should be an API Key with the Advertiser scope
required: true
schema:
type: string
- name: X-Api-Version
in: header
description: Note that you must pass a version 3 header to get this API
schema:
type: string
default: 3.0.0
requestBody:
content:
application/json:
schema:
type: object
required:
- game_id
- fields
- groups
- filters
properties:
game_id:
type: integer
description: The ID of the Game to pull reporting for
format: int32
fields:
type: array
description: Fields set the list of metrics returned. See the full list of supported fields [here](#fields).
items:
type: string
groups:
type: array
description: Groups set the dimensions returned from the report. See the full list of supported groups [here](#groups).
items:
type: string
filters:
type: object
description: List of filters to restrict the results
properties:
start_triggered_at_date:
type: string
description: Start of the date range to run the report over
format: date
end_triggered_at_date:
type: string
description: End of the date range to run the report over
format: date
team_ids:
type: array
items:
type: integer
format: int32
networks:
type: array
items:
type: string
campaigns:
type: array
items:
type: string
ad_groups:
type: array
items:
type: string
ads:
type: array
items:
type: string
sub1:
type: array
items:
type: string
sub2:
type: array
items:
type: string
sub3:
type: array
items:
type: string
sub4:
type: array
items:
type: string
sub5:
type: array
items:
type: string
countries:
type: array
items:
type: string
user_ids:
type: array
items:
type: string
platforms:
type: array
items:
type: string
touchpoint_types:
type: array
description: 'Allowed values: `[''click'', ''impression'']`'
items:
type: string
goal_type_ids:
type: array
description: List of goal types to restrict results to include
items:
type: integer
format: int32
include_unattributed:
type: boolean
description: Set to True to include a row in the response for unattributed goals.
default: false
timezone:
type: string
description: Timezone to adjust all reported dates/times into. Reference for supported formats [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
default: UTC
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"results\": [\n {\n \"campaign\": \"google-ads-game-launch-campaign\",\n \"campaign_name\": \"Google Ads Game Launch Campaign\",\n \"click_through_rate\": 41.93876939668085,\n \"clicks\": 7000,\n \"clicks_unique\": 5678,\n \"cost_amount\": 238.14,\n \"cost_currency\": \"USD\",\n \"display_click_through_rate\": 41.93876939668085,\n \"display_clicks\": 7000,\n \"display_cost_amount\": 238.14,\n \"display_cost_currency\": \"USD\",\n \"display_impressions\": 16691,\n \"game_id\": 1,\n \"goal_revenue_amount\": 2900.22,\n \"goal_revenue_currency\": \"USD\",\n \"goals\": {\n \"1\": {\n \"assist\": {\n \"count\": 825,\n \"goal_rate\": 11.785714285714285,\n \"goal_revenue_amount\": 0.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"Purchase Assist\",\n \"per_user\": 2.759197324414716,\n \"unique_users\": 299\n },\n \"standard\": {\n \"count\": 110,\n \"goal_rate\": 1.5714285714285716,\n \"goal_revenue_amount\": 220.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"Purchase\",\n \"per_user\": 1.0,\n \"unique_users\": 110\n }\n },\n \"2\": {\n \"assist\": {\n \"count\": 126,\n \"goal_rate\": 1.7999999999999998,\n \"goal_revenue_amount\": 0.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"Reactivation Assist\",\n \"per_user\": 2.3333333333333335,\n \"unique_users\": 54\n },\n \"standard\": {\n \"count\": 31,\n \"goal_rate\": 0.44285714285714284,\n \"goal_revenue_amount\": 62.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"Reactivation\",\n \"per_user\": 1.0,\n \"unique_users\": 31\n }\n },\n \"3\": {\n \"assist\": {\n \"count\": 1575,\n \"goal_rate\": 22.5,\n \"goal_revenue_amount\": 0.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"DLC Purchase Assist\",\n \"per_user\": 4.578488372093023,\n \"unique_users\": 344\n },\n \"standard\": {\n \"count\": 178,\n \"goal_rate\": 2.5428571428571427,\n \"goal_revenue_amount\": 1778.22,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"DLC Purchase\",\n \"per_user\": 1.3088235294117647,\n \"unique_users\": 136\n }\n },\n \"4\": {\n \"assist\": {\n \"count\": 1788,\n \"goal_rate\": 25.542857142857144,\n \"goal_revenue_amount\": 0.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"3D Retention Assist\",\n \"per_user\": 2.4594222833562585,\n \"unique_users\": 727\n },\n \"contribution\": {\n \"count\": 729,\n \"goal_rate\": 10.414285714285715,\n \"goal_revenue_amount\": 0.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"3D Retention Contribution\",\n \"per_user\": 2.5759717314487633,\n \"unique_users\": 283\n },\n \"standard\": {\n \"count\": 451,\n \"goal_rate\": 6.442857142857143,\n \"goal_revenue_amount\": 840.0,\n \"goal_revenue_currency\": \"USD\",\n \"name\": \"3D Retention\",\n \"per_user\": 1.0134831460674156,\n \"unique_users\": 445\n }\n }\n },\n \"impressions\": 16691,\n \"impressions_unique\": 8740,\n \"network\": \"adwords\",\n \"network_click_through_rate\": null,\n \"network_clicks\": null,\n \"network_cost_amount\": null,\n \"network_cost_currency\": null,\n \"network_impressions\": null,\n \"network_name\": \"Google Ads\",\n \"team_id\": 1,\n \"team_name\": \"Team Defaults\"\n }\n ]\n}"
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
campaign:
type: string
example: google-ads-game-launch-campaign
campaign_name:
type: string
example: Google Ads Game Launch Campaign
click_through_rate:
type: number
example: 41.93876939668085
default: 0
clicks:
type: integer
example: 7000
default: 0
clicks_unique:
type: integer
example: 5678
default: 0
cost_amount:
type: number
example: 238.14
default: 0
cost_currency:
type: string
example: USD
display_click_through_rate:
type: number
example: 41.93876939668085
default: 0
display_clicks:
type: integer
example: 7000
default: 0
display_cost_amount:
type: number
example: 238.14
default: 0
display_cost_currency:
type: string
example: USD
display_impressions:
type: integer
example: 16691
default: 0
game_id:
type: integer
example: 1
default: 0
goal_revenue_amount:
type: number
example: 2900.22
default: 0
goal_revenue_currency:
type: string
example: USD
goals:
type: object
properties:
'1':
type: object
properties:
assist:
type: object
properties:
count:
type: integer
example: 825
default: 0
goal_rate:
type: number
example: 11.785714285714285
default: 0
goal_revenue_amount:
type: integer
example: 0
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: Purchase Assist
per_user:
type: number
example: 2.759197324414716
default: 0
unique_users:
type: integer
example: 299
default: 0
standard:
type: object
properties:
count:
type: integer
example: 110
default: 0
goal_rate:
type: number
example: 1.5714285714285716
default: 0
goal_revenue_amount:
type: integer
example: 220
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: Purchase
per_user:
type: integer
example: 1
default: 0
unique_users:
type: integer
example: 110
default: 0
'2':
type: object
properties:
assist:
type: object
properties:
count:
type: integer
example: 126
default: 0
goal_rate:
type: number
example: 1.7999999999999998
default: 0
goal_revenue_amount:
type: integer
example: 0
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: Reactivation Assist
per_user:
type: number
example: 2.3333333333333335
default: 0
unique_users:
type: integer
example: 54
default: 0
standard:
type: object
properties:
count:
type: integer
example: 31
default: 0
goal_rate:
type: number
example: 0.44285714285714284
default: 0
goal_revenue_amount:
type: integer
example: 62
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: Reactivation
per_user:
type: integer
example: 1
default: 0
unique_users:
type: integer
example: 31
default: 0
'3':
type: object
properties:
assist:
type: object
properties:
count:
type: integer
example: 1575
default: 0
goal_rate:
type: number
example: 22.5
default: 0
goal_revenue_amount:
type: integer
example: 0
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: DLC Purchase Assist
per_user:
type: number
example: 4.578488372093023
default: 0
unique_users:
type: integer
example: 344
default: 0
standard:
type: object
properties:
count:
type: integer
example: 178
default: 0
goal_rate:
type: number
example: 2.5428571428571427
default: 0
goal_revenue_amount:
type: number
example: 1778.22
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: DLC Purchase
per_user:
type: number
example: 1.3088235294117647
default: 0
unique_users:
type: integer
example: 136
default: 0
'4':
type: object
properties:
assist:
type: object
properties:
count:
type: integer
example: 1788
default: 0
goal_rate:
type: number
example: 25.542857142857144
default: 0
goal_revenue_amount:
type: integer
example: 0
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: 3D Retention Assist
per_user:
type: number
example: 2.4594222833562585
default: 0
unique_users:
type: integer
example: 727
default: 0
contribution:
type: object
properties:
count:
type: integer
example: 729
default: 0
goal_rate:
type: number
example: 10.414285714285715
default: 0
goal_revenue_amount:
type: integer
example: 0
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: 3D Retention Contribution
per_user:
type: number
example: 2.5759717314487633
default: 0
unique_users:
type: integer
example: 283
default: 0
standard:
type: object
properties:
count:
type: integer
example: 451
default: 0
goal_rate:
type: number
example: 6.442857142857143
default: 0
goal_revenue_amount:
type: integer
example: 840
default: 0
goal_revenue_currency:
type: string
example: USD
name:
type: string
example: 3D Retention
per_user:
type: number
example: 1.0134831460674156
default: 0
unique_users:
type: integer
example: 445
default: 0
impressions:
type: integer
example: 16691
default: 0
impressions_unique:
type: integer
example: 8740
default: 0
network:
type: string
example: adwords
network_click_through_rate: {}
network_clicks: {}
network_cost_amount: {}
network_cost_currency: {}
network_impressions: {}
network_name:
type: string
example: Google Ads
team_id:
type: integer
example: 1
default: 0
team_name:
type: string
example: Team Defaults
deprecated: false
tags:
- Reporting
/reporting/goals:
post:
summary: /reporting/goals
description: ''
operationId: reportinggoals
parameters:
- name: Authorization
in: header
description: This should be an API Key with the Advertiser scope
required: true
schema:
type: string
- name: X-Api-Version
in: header
schema:
type: string
default: 2.0.0
requestBody:
content:
application/json:
schema:
type: object
required:
- game_id
- start_datetime
- end_datetime
properties:
game_id:
type: integer
description: Game to pull goals for
format: int32
start_datetime:
type: string
description: Pull goals triggered after this time (inclusive)
format: date
end_datetime:
type: string
description: Pull goals triggered before this time (exclusive)
format: date
goal_type_ids:
type: array
description: Restrict the results to the provided goal types
items:
type: integer
format: int32
trigger_types:
type: array
description: Restrict the results to the provided trigger types (standard, assist, contribution)
items:
type: string
unattributed:
type: boolean
description: Restrict the results to only include unattributed (True), attributed (False), or all (Null)
limit:
type: integer
description: Limit the number of results per page. Max 1,000,000 results per page
default: 100000
format: int32
after:
type: string
description: Pull the page starting with this page token
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"goals\": [\n {\n \"event_city\": 0,\n \"event_country\": \"US\",\n \"event_device_type\": null,\n \"event_id\": \"1ec20fd8-28ba-664e-8ecf-9801a795bcd3\",\n \"event_os\": \"Windows 7 Service Pack 1\",\n \"event_platform\": \"xbox\",\n \"event_region\": \"ZZZ\",\n \"event_sku\": \"\",\n \"event_type\": \"game_launch\",\n \"game_id\": 1,\n \"goal_type_id\": 1,\n \"id\": \"1ec20fd8-28ba-6450-8ecf-9801a795bcd3\",\n \"record_updated_at\": \"2021-09-29T08:16:14\",\n \"revenue_amount\": 0.0,\n \"revenue_currency\": \"USD\",\n \"revenue_type\": \"cumulative\",\n \"touchpoint_ad\": \"\",\n \"touchpoint_ad_group\": \"myadgroup\",\n \"touchpoint_ad_type\": \"\",\n \"touchpoint_browser_family\": \"Chrome\",\n \"touchpoint_campaign\": \"1\",\n \"touchpoint_city\": 0,\n \"touchpoint_cost_amount\": 1.0,\n \"touchpoint_cost_currency\": \"USD\",\n \"touchpoint_cost_model\": \"cpc\",\n \"touchpoint_country\": \"US\",\n \"touchpoint_creative\": \"\",\n \"touchpoint_destination_url\": \"https://store.steampowered.com\",\n \"touchpoint_device_brand\": \"Apple\",\n \"touchpoint_device_family\": \"Mac\",\n \"touchpoint_device_model\": \"Mac\",\n \"touchpoint_id\": \"1ec20fd8-288c-6078-8ecf-9801a795bcd3\",\n \"touchpoint_influencer\": \"\",\n \"touchpoint_keyword\": \"\",\n \"touchpoint_network\": \"\",\n \"touchpoint_os_family\": \"Mac OS X\",\n \"touchpoint_os_major\": \"10\",\n \"touchpoint_placement\": \"\",\n \"touchpoint_region\": \"ZZZ\",\n \"touchpoint_request_url\": \"http://gsght.com/c/xxxxx?ad_group=myadgroup\",\n \"touchpoint_requested_at\": \"2021-09-26T08:16:12\",\n \"touchpoint_session_id\": \"1ec20fd8-288c-61cc-8ecf-9801a795bcd3\",\n \"touchpoint_site_id\": \"\",\n \"touchpoint_sub1\": \"\",\n \"touchpoint_sub10\": \"\",\n \"touchpoint_sub2\": \"\",\n \"touchpoint_sub3\": \"\",\n \"t
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gamesight/refs/heads/main/openapi/gamesight-reporting-api-openapi.yml