概览指标终端

通过此终端为应用调取指标。

操作前须知

要使用该终端，您需要 Adjust API 识别码。请按照验证指南中的说明操作，获得识别码。

应用概览终端

https://api.adjust.com/kpis/v1/{app_token}

GET 请求

返回与应用关联的指标。返回的指标位于 kpi_values 数组中且排列顺序与您的请求中一致。

终端默认返回 JSON。若要返回 CSV，请在调用中添加以下标头：

Accept: text/csv

参数

参数	格式	In	描述
`app_token` 必要	字符串	路径 (Path)	应用的 10 字符标识符。
`start_date`	日期	查询	所选周期的起始日期。格式为 `YYYY-MM-DD`。
`end_date`	日期	查询	选定周期的结束日期。格式为 `YYYY-MM-DD`。
`utc_offset`	时间	查询	与UTC 0 时区的时差，例如：如果您希望查询的起止日期是以北京时间定义的，那么您在此可以设此参数为：utc_offset=08:00。格式为`[+-]HH:MM`。
`kpis`	字符串	查询	用逗号隔开的指标列表。可选项包括：应用指标作弊指标 (需要防作弊套件) 广告支出指标
`event_kpis`	字符串	查询	用逗号隔开的事件指标列表。请在每个指标前附加事件识别码。例如，`token1_revenue`
`reattributed`	字符串	查询	根据以下条件过滤指标：已安装用户 (`false`) 再归因用户 (`true`) `所有`用户 (默认)
`sandbox`	布尔	查询	结果来自 sandbox 数据还是真实数据。默认为真实数据 (`false`)。
`attribution_type`	字符串	查询	结果中包含的归因类型。可选项包括： `点击` `展示` `全部`
`attribution_source`	字符串	查询	确定应用内活动是分配给用户的安装来源 (first)，还是分配给安装来源和后续再归因来源 (dynamic)。默认情况下，设置为 dynamic。
`countries`	字符串	查询	用逗号隔开的国家/地区名称列表 (采用 ISO 3166 alpha-2 代码)。
`os_names`	字符串	查询	用逗号隔开的操作系统名称列表。
`device_types`	字符串	查询	用逗号隔开的设备类型列表。
`regions`	字符串	查询	由逗号分隔的标准或账户特定业务地区列表。在地区名称之前添加 `+` 或 `-` 号来包含 (默认) 或排除地区。
`grouping`	字符串	查询	为参数分组。更多信息，请查看结果分组。
`tracker_filter`	字符串	查询	您想包含在结果中的任意跟踪链接的跟踪码。只有与这些跟踪链接相关的指标才会被返回。
`cohort_revenue_period`	字符串	查询	用于计算收入总数的再归因后天数。
`human_readable_kpis`	布尔	查询	使用人类可读的名称代替指标 (例如，"`Lifetime Value`" ，而非 `lifetime_value`)。

示例

JSON

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb' \
--header 'Authorization: Token token={your_api_token}'

响应

{
  "result_parameters": {
    "kpis": ["sessions", "installs"],
    "start_date": "2022-05-01",
    "end_date": "2022-05-31",
    "sandbox": false,
    "countries": ["de", "gb"],
    "trackers": [
      {
        "token": "12djsk",
        "name": "Network 1",
        "has_subtrackers": true
      },
      {
        "token": "15jvui",
        "name": "Network 2",
        "has_subtrackers": true
      }
    ],
    "grouping": ["trackers"]
  },
  "result_set": {
    "token": "2eb2na2w54c3",
    "name": "app name",
    "currency": "USD",
    "trackers": [
      {
        "token": "12djsk",
        "kpi_values": [39629, 39629]
      },
      {
        "token": "15jvui",
        "kpi_values": [557, 880]
      }
    ]
  }
}

CSV

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb' \
--header 'Authorization: Token token={your_api_token}' \
--header 'Accept: text/csv'

响应

tracker_token,tracker_name,sessions,installs
12djsk,Network 1,39629,39629
15jvui,Network 2,557,880

多应用概览终端

https://api.adjust.com/kpis/v1/{app_tokens}

GET 请求

返回与多个应用关联的指标。返回的指标位于 kpi_values 数组中且排列顺序与您的请求中一致。

终端默认返回 JSON。若要返回 CSV，请在调用中添加以下标头：

Accept: text/csv

参数

参数	格式	In	描述
`app_tokens` 必要	字符串	查询	用逗号隔开的应用识别码列表。
`start_date`	日期	查询	所选周期的起始日期。格式为 `YYYY-MM-DD`。
`end_date`	日期	查询	选定周期的结束日期。格式为 `YYYY-MM-DD`。
`utc_offset`	时间	查询	与UTC 0 时区的时差，例如：如果您希望查询的起止日期是以北京时间定义的，那么您在此可以设此参数为：utc_offset=08:00。格式为`[+-]HH:MM`。
`kpis`	字符串	查询	用逗号隔开的指标列表。可选项包括：应用指标作弊指标 (需要防作弊套件) 广告支出指标
`sandbox`	布尔	查询	结果来自 sandbox 数据还是真实数据。默认为真实数据 (`false`)。
`countries`	字符串	查询	用逗号隔开的国家/地区名称列表 (采用 ISO 3166 alpha-2 代码)。
`os_names`	字符串	查询	用逗号隔开的操作系统名称列表。
`device_types`	字符串	查询	用逗号隔开的设备类型列表。
`grouping`	字符串	查询	为参数分组。更多信息，请查看结果分组。
`tracker_filter`	字符串	查询	您想包含在结果中的任意跟踪链接的跟踪码。只有与这些跟踪链接相关的指标才会被返回。
`human_readable_kpis`	布尔	查询	使用人类可读的名称代替指标 (例如，"`Lifetime Value`" ，而非 `lifetime_value`)。

示例

JSON

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3,3fdwnag4ecf2?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb&human_readable_kpis=true' \
--header 'Authorization: Token token={your_app_token}' \

响应

{
    "result_parameters": {
        "kpis": [
            "Sessions"
        ],
        "start_date": "2022-05-01",
        "end_date": "2022-05-31",
        "sandbox": false,
        "countries": [
            "de",
            "gb"
        ],
        "grouping": [
            "apps"
        ],
        "attribution_type": "click",
        "utc_offset": "00:00",
        "attribution_source": "dynamic"
    },
    "result_set": {
        "apps": [
            {
                "token": "2eb2na2w54c3",
                "name": "app name",
                "currency": "EUR",
                "kpi_values": [
                    3
                ]
            },
            {
                "token": "3fdwnag4ecf2",
                "name": "test app",
                "currency": "EUR",
                "kpi_values": [
                    40149
                ]
            }
        ]
    }
}

CSV

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3,3fdwnag4ecf2?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb&human_readable_kpis=true' \
--header 'Authorization: Token token={your_app_token}' \
--header 'Accept: text/csv'

响应

App Token,App Name,Sessions
2eb2na2w54c3,app name,3
3fdwnag4ecf2,test app,40149

跟踪链接概览终端

https://api.adjust.com/kpis/v1/{app_token}/trackers/{tracker_token}

GET 请求

返回与特定跟踪链接关联的指标。返回的指标位于 kpi_values 数组中且位置与您请求的 KPI 一致。

终端默认返回 JSON。若要返回 CSV，请在调用中添加以下标头：

Accept: text/csv

参数

参数	格式	In	描述
`app_token` 必要	字符串	路径 (Path)	应用的 10 字符标识符。
`tracker_token` 必要	字符串	路径 (Path)	跟踪链接的 6 字符识别码。
`start_date`	日期	查询	所选周期的起始日期。格式为 `YYYY-MM-DD`。
`end_date`	日期	查询	选定周期的结束日期。格式为 `YYYY-MM-DD`。
`utc_offset`	时间	查询	与UTC 0 时区的时差，例如：如果您希望查询的起止日期是以北京时间定义的，那么您在此可以设此参数为：utc_offset=08:00。格式为`[+-]HH:MM`。
`kpis`	字符串	查询	用逗号隔开的指标列表。可选项包括：应用指标作弊指标 (需要防作弊套件) 广告支出指标
`event_kpis`	字符串	查询	用逗号隔开的事件指标列表。请在每个指标前附加事件识别码。例如，`token1_revenue`
`reattributed`	字符串	查询	根据以下条件过滤指标：已安装用户 (`false`) 再归因用户 (`true`) `所有`用户 (默认)
`sandbox`	布尔	查询	结果来自 sandbox 数据还是真实数据。默认为真实数据 (`false`)。
`attribution_type`	字符串	查询	结果中包含的归因类型。可选项包括： `点击` `展示` `全部`
`attribution_source`	字符串	查询	确定应用内活动是分配给用户的安装来源 (first)，还是分配给安装来源和后续再归因来源 (dynamic)。默认情况下，设置为 dynamic。
`countries`	字符串	查询	用逗号隔开的国家/地区名称列表 (采用 ISO 3166 alpha-2 代码)。
`os_names`	字符串	查询	用逗号隔开的操作系统名称列表。
`device_types`	字符串	查询	用逗号隔开的设备类型列表。
`regions`	字符串	查询	由逗号分隔的标准或账户特定业务地区列表。在地区名称之前添加 `+` 或 `-` 号来包含 (默认) 或排除地区。
`grouping`	字符串	查询	为参数分组。更多信息，请查看结果分组。
`tracker_filter`	字符串	查询	您想包含在结果中的任意跟踪链接的跟踪码。只有与这些跟踪链接相关的指标才会被返回。
`cohort_revenue_period`	字符串	查询	用于计算收入总数的再归因后天数。
`human_readable_kpis`	布尔	查询	使用人类可读的名称代替指标 (例如，"`Lifetime Value`" ，而非 `lifetime_value`)。

示例

JSON

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb' \
--header 'Authorization: Token token={your_api_token}'

响应

{
  "result_parameters": {
    "kpis": ["sessions", "installs"],
    "start_date": "2022-05-01",
    "end_date": "2022-05-31",
    "sandbox": false,
    "countries": ["de", "gb"],
    "trackers": [
      {
        "token": "12djsk",
        "name": "Network 1",
        "has_subtrackers": true
      }
    ],
    "grouping": ["trackers"]
  },
  "result_set": {
    "token": "2eb2na2w54c3",
    "name": "app name",
    "currency": "USD",
    "trackers": [
      {
        "token": "12djsk",
        "kpi_values": [39629, 39629]
      }
    ]
  }
}

CSV

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb' \
--header 'Authorization: Token token={your_api_token}' \
--header 'Accept: text/csv'

响应

tracker_token,tracker_name,sessions,installs
12djsk,Network 1,39629,39629

响应格式

JSON

{
  "result_parameters": {
    "kpis": [
       "string",
       "string"
    ],
    "start_date": "2022-01-01",
    "end_date": "2022-01-31",
    "sandbox": false,
    "countries": [
       "string"
    ],
    "trackers": [
      {
        "token": "string",
        "name": "string",
        "has_subtrackers": true
      },
      {
        "token": "string",
        "name": "string",
        "has_subtrackers": true
      }
    ],
    "grouping": [
       "string"
    ]
  },
  "result_set": {
    "token": "string",
    "name": "string",
    "currency": "string",
    "apps": [ // Returned when querying multiple apps
      {
         "token": "string",
         "name": "string",
         "currency": "string",
         "kpi_values": [
            3
         ]
      },
    "trackers": [ // Returned when querying a single app
      {
        "token": "string",
        "kpi_values": [
           100,
           130.24
        ]
      },
      {
        "token": "string",
        "kpi_values": [
           557, 
           0.802
        ]
      }
    ]
  }
}

CSV

默认参数

参数	默认值
`kpis`	`clicks` `安装` `click_conversion_rate` `reattributions` `sessions` `revenue_events` `revenue` `daus` `waus` `maus`

概览指标终端

参数

示例

JSON

响应

CSV

响应

参数

示例

JSON

响应

CSV

响应

参数

示例

JSON

响应

CSV

响应

JSON

CSV

操作系统名称

设备类型