同期群指标终端

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

操作前须知

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

同期群概览终端

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

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`	字符串	查询	用逗号隔开的指标列表。可选项包括：应用指标作弊指标 (需要防作弊套件) 广告支出指标
`sandbox`	布尔	查询	结果来自 sandbox 数据还是真实数据。默认为真实数据 (`false`)。
`attribution_type`	字符串	查询	结果中包含的归因类型。可选项包括： `点击` `展示` `全部`
`period`	字符串	查询	结果中包含的同期群周期。可选项包括： `天` `week` `month`
`reattributed`	字符串	查询	根据以下条件过滤指标：已安装用户 (`false`) 再归因用户 (`true`) `所有`用户 (默认)
`事件`	字符串	查询	用逗号隔开的事件识别码列表。
`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/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb' \
--header 'Authorization: Token token={your_api_token}'

响应

{
    "result_parameters": {
        "kpis": [
            "sessions"
        ],
        "start_date": "2022-07-01",
        "end_date": "2022-07-28",
        "sandbox": false,
        "countries": [
            "de",
            "gb"
        ],
        "events": [
            {
                "name": "General Revenue Event",
                "token": "0"
            }
        ],
        "trackers": [
            {
                "token": "12djsk",
                "name": "Network 1",
                "has_subtrackers": false
            }
        ],
        "grouping": [
            "trackers",
            "weeks",
            "events",
            "periods"
        ],
        "period": "week",
        "attribution_type": "click",
        "utc_offset": "00:00",
        "day_def": "24h",
        "attribution_source": "dynamic"
    },
    "result_set": {
        "token": "2eb2na2w54c3",
        "name": "First tracker",
        "currency": "EUR",
        "trackers": [
            {
                "token": "12djsk",
                "dates": [
                    {
                        "date": "2022-04-27",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            4295
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-04",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            10073
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-11",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            10080
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-18",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            10080
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-25",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            5213
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

CSV

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&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,event_name,period,sessions
12djsk,Network 1,2022-04-27,0,General Revenue Event,0,4295
12djsk,Network 1,2022-05-04,0,General Revenue Event,0,10073
12djsk,Network 1,2022-05-11,0,General Revenue Event,0,10080
12djsk,Network 1,2022-05-18,0,General Revenue Event,0,10080
12djsk,Network 1,2022-05-25,0,General Revenue Event,0,5212

多应用同期群终端

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

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/cohorts?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",
            "periods"
        ],
        "period": "day",
        "attribution_type": "click",
        "utc_offset": "00:00",
        "day_def": "24h",
        "attribution_source": "dynamic"
    },
    "result_set": {
        "apps": [
            {
                "token": "2eb2na2w54c3",
                "name": "app name",
                "currency": "EUR",
                "periods": [
                    {
                        "period": "0",
                        "kpi_values": [
                            3
                        ]
                    }
                ]
            },
            {
                "token": "3fdwnag4ecf2",
                "name": "test app",
                "currency": "EUR",
                "periods": [
                    {
                        "period": "0",
                        "kpi_values": [
                            40158
                        ]
                    }
                ]
            }
        ]
    }
}

CSV

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3,3fdwnag4ecf2/cohorts?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,Days after Install,Sessions
2eb2na2w54c3,app name,0,3
3fdwnag4ecf2,test app,0,40162

跟踪链接同期群终端

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

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`	字符串	查询	用逗号隔开的指标列表。可选项包括：应用指标作弊指标 (需要防作弊套件) 广告支出指标
`sandbox`	布尔	查询	结果来自 sandbox 数据还是真实数据。默认为真实数据 (`false`)。
`attribution_type`	字符串	查询	结果中包含的归因类型。可选项包括： `点击` `展示` `全部`
`period`	字符串	查询	结果中包含的同期群周期。可选项包括： `天` `week` `month`
`reattributed`	字符串	查询	根据以下条件过滤指标：已安装用户 (`false`) 再归因用户 (`true`) `所有`用户 (默认)
`事件`	字符串	查询	用逗号隔开的事件识别码列表。
`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/trackers/12djsk/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb' \
--header 'Authorization: Token token={your_api_token}'

响应

{
    "result_parameters": {
        "kpis": [
            "sessions"
        ],
        "start_date": "2022-07-01",
        "end_date": "2022-07-28",
        "sandbox": false,
        "countries": [
            "de",
            "gb"
        ],
        "events": [
            {
                "name": "General Revenue Event",
                "token": "0"
            }
        ],
        "trackers": [
            {
                "token": "12djsk",
                "name": "Network 1",
                "has_subtrackers": false
            }
        ],
        "grouping": [
            "trackers",
            "weeks",
            "events",
            "periods"
        ],
        "period": "week",
        "attribution_type": "click",
        "utc_offset": "00:00",
        "day_def": "24h",
        "attribution_source": "dynamic"
    },
    "result_set": {
        "token": "2eb2na2w54c3",
        "name": "First tracker",
        "currency": "EUR",
        "trackers": [
            {
                "token": "12djsk",
                "dates": [
                    {
                        "date": "2022-04-27",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            4295
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-04",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            10073
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-11",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            10080
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-18",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            10080
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "date": "2022-05-25",
                        "events": [
                            {
                                "token": "0",
                                "periods": [
                                    {
                                        "period": "0",
                                        "kpi_values": [
                                            5213
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

CSV

curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&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,event_name,period,sessions
12djsk,Network 1,2022-04-27,0,General Revenue Event,0,4295
12djsk,Network 1,2022-05-04,0,General Revenue Event,0,10073
12djsk,Network 1,2022-05-11,0,General Revenue Event,0,10080
12djsk,Network 1,2022-05-18,0,General Revenue Event,0,10080
12djsk,Network 1,2022-05-25,0,General Revenue Event,0,5212

响应格式

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": false
            }
        ],
        "grouping": [
            "string"
        ],
        "period": "string",
        "attribution_type": "string",
        "utc_offset": "00:00",
        "day_def": "string",
        "attribution_source": "string"
    },
    "result_set": {
        "token": "string",
        "name": "string",
        "currency": "string",
        "apps": [ // Returned when querying multiple apps
            {
                "token": "string",
                "name": "string",
                "currency": "string",
                "periods": [
                    {
                        "period": "0",
                        "kpi_values": [
                            3
                        ]
                    }
                ]
            },
        "trackers": [ // Returned when querying a single app
            {
                "token": "string",
                "dates": [
                    {
                        "date": "2022-06-27",
                        "events": [
                            {
                                "token": "string",
                                "periods": [
                                    {
                                        "period": "string",
                                        "kpi_values": [
                                            1
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

CSV

默认参数

参数	默认值
`kpis`	`retention_rate`

同期群指标终端

参数

示例

JSON

响应

CSV

响应

参数

示例

JSON

响应

CSV

响应

参数

示例

JSON

响应

CSV

响应

JSON

CSV

操作系统名称

设备类型