We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.

开发者

事件指标终端

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

操作前须知

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

事件概览终端

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

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`	字符串	查询	用逗号隔开的事件指标列表。请在每个指标前附加事件识别码。例如，`token1_revenue`
`sandbox`	布尔	查询	结果来自 sandbox 数据还是真实数据。默认为真实数据 (`false`)。
`事件`	字符串	查询	用逗号隔开的事件识别码列表。
`attribution_type`	字符串	查询	结果中包含的归因类型。可选项包括： `点击` `展示` `全部`
`attribution_source`	字符串	查询	确定应用内活动是分配给用户的安装来源 (first)，还是分配给安装来源和后续再归因来源 (dynamic)。默认情况下，设置为 dynamic。
`countries`	字符串	查询	用逗号隔开的国家/地区名称列表 (采用 ISO 3166 alpha-2 代码)。
`os_names`	字符串	查询	用逗号隔开的操作系统名称列表。
`device_types`	字符串	查询	用逗号隔开的设备类型列表。
`grouping`	字符串	查询	为参数分组。更多信息，请查看结果分组。
`tracker_filter`	字符串	查询	您想包含在结果中的任意跟踪链接的跟踪码。只有与这些跟踪链接相关的指标才会被返回。
`partner_ids`	字符串	查询	用逗号隔开的合作伙伴 ID 列表。只有该列表中合作伙伴的指标会被返回。
`human_readable_kpis`	布尔	查询	使用人类可读的名称代替指标 (例如，"`Lifetime Value`" ，而非 `lifetime_value`)。

示例

JSON

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/events?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": ["revenue", "events", "revenue_per_event"],
    "start_date": "2022-05-01",
    "end_date": "2022-05-31",
    "sandbox": false,
    "countries": ["de", "gb"],
    "events": [{"token": "abcdef","name": "Login"}, {"token": "badcfe","name": "Level Up"}],
    "grouping": ["trackers", "weeks", "events"],
    "trackers": [
      {
        "token": "12djsk",
        "name": "Network 1",
        "has_subtrackers": true
      }
    ]
  },
  "result_set": {
    "token": "2eb2na2w54c3",
    "name": "app name",
    "currency": "USD",
    "trackers": [
      {
        "token": "12djsk",
        "dates": [
          {
            "date": "2022-05-02",
            "events": [
              {
                "token": "abcdef",
                "kpi_values": [4, 5, 0.8]
              },
              {
                "token": "badcfe",
                "kpi_values": [3, 5, 7.2]
              }
            ]
          },
          {
            "date": "2022-05-09",
            "events": [
              {
                "token": "badcfe",
                "kpi_values": [4, 5, 0.8]
              }
            ]
          }
        ]
      }
    ]
  }
}

CSV

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/events?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,date,event_token,revenue,events,revenue_per_event
12djsk,Network 1,2022-05-02,abcdef,4,5,0.8
12djsk,Network 1,2022-05-02,badcfe,3,5,7.2
12djsk,Network 1,2022-05-09,badcfe,4,5,0.8

跟踪链接事件终端

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

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`	字符串	查询	用逗号隔开的事件指标列表。请在每个指标前附加事件识别码。例如，`token1_revenue`
`sandbox`	布尔	查询	结果来自 sandbox 数据还是真实数据。默认为真实数据 (`false`)。
`事件`	字符串	查询	用逗号隔开的事件识别码列表。
`attribution_type`	字符串	查询	结果中包含的归因类型。可选项包括： `点击` `展示` `全部`
`attribution_source`	字符串	查询	确定应用内活动是分配给用户的安装来源 (first)，还是分配给安装来源和后续再归因来源 (dynamic)。默认情况下，设置为 dynamic。
`countries`	字符串	查询	用逗号隔开的国家/地区名称列表 (采用 ISO 3166 alpha-2 代码)。
`os_names`	字符串	查询	用逗号隔开的操作系统名称列表。
`device_types`	字符串	查询	用逗号隔开的设备类型列表。
`grouping`	字符串	查询	为参数分组。更多信息，请查看结果分组。
`tracker_filter`	字符串	查询	您想包含在结果中的任意跟踪链接的跟踪码。只有与这些跟踪链接相关的指标才会被返回。
`partner_ids`	字符串	查询	用逗号隔开的合作伙伴 ID 列表。只有该列表中合作伙伴的指标会被返回。
`human_readable_kpis`	布尔	查询	使用人类可读的名称代替指标 (例如，"`Lifetime Value`" ，而非 `lifetime_value`)。

示例

JSON

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk/events?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": ["revenue", "events", "revenue_per_event"],
    "start_date": "2022-05-01",
    "end_date": "2022-05-31",
    "sandbox": false,
    "countries": ["de", "gb"],
    "events": [{"token": "abcdef","name": "Login"}, {"token": "badcfe","name": "Level Up"}],
    "grouping": ["trackers", "weeks", "events"],
    "trackers": [
      {
        "token": "12djsk",
        "name": "Network 1",
        "has_subtrackers": true
      }
    ]
  },
  "result_set": {
    "token": "2eb2na2w54c3",
    "name": "app name",
    "currency": "USD",
    "trackers": [
      {
        "token": "12djsk",
        "dates": [
          {
            "date": "2022-05-02",
            "events": [
              {
                "token": "abcdef",
                "kpi_values": [4, 5, 0.8]
              },
              {
                "token": "badcfe",
                "kpi_values": [3, 5, 7.2]
              }
            ]
          },
          {
            "date": "2022-05-09",
            "events": [
              {
                "token": "badcfe",
                "kpi_values": [4, 5, 0.8]
              }
            ]
          }
        ]
      }
    ]
  }
}

CSV

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

响应

tracker_token,tracker_name,date,event_token,revenue,events,revenue_per_event
12djsk,Network 1,2022-05-02,abcdef,4,5,0.8
12djsk,Network 1,2022-05-02,badcfe,3,5,7.2
12djsk,Network 1,2022-05-09,badcfe,4,5,0.8

响应格式

JSON

{
    "result_parameters": {
        "kpis": [
            "string"
        ],
        "start_date": "2022-07-01",
        "end_date": "2022-07-28",
        "sandbox": false,
        "countries": [
            "string"
        ],
        "events": [
            {
                "name": "string",
                "token": "string"
            }
        ],
        "trackers": [
            {
                "token": "string",
                "name": "string",
                "has_subtrackers": true
            }
        ],
        "grouping": [
            "string"
        ],
        "attribution_type": "string",
        "utc_offset": "00:00",
        "attribution_source": "string"
    },
    "result_set": {
        "token": "string",
        "name": "string",
        "currency": "string",
        "trackers": [
            {
                "token": "string",
                "dates": [
                    {
                        "date": "2022-06-27",
                        "events": [
                            {
                                "token": "string",
                                "kpi_values": [
                                    12887
                                ]
                            }
                        ]
                    }
                ]
            },
            {
                "token": "string",
                "dates": [
                    {
                        "date": "2022-06-27",
                        "events": [
                            {
                                "token": "string",
                                "kpi_values": [
                                    2
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

CSV

默认参数

参数	默认值
`kpis`	`revenue_events` `revenue`

事件指标终端

参数

示例

JSON

响应

CSV

响应

参数

示例

JSON

响应

CSV

响应

JSON

CSV

操作系统名称

设备类型