Необходимо создать API метод, который будет использоваться Aitarget для запроса статистики "на лету".
Наиболее предпочтительнее POST метод возвращающий JSON.
Метод ДОЛЖЕН принимать:
- ids - массив идентификаторов сущностей Facebook, по которым запрашиваются данные.
- fields - массив полей, данные которых мы запрашиваем.
- Либо пара date_start date_stop вида 2017-03-27, либо одно поле date_preset, принимающим значения: last_hour - это за последний час, prev_hour - за предыдущий час.
- time_increment - период группировки статистики (используется только с парой date_start и date_stop): 'monthly'(помесячно), 'all_days'(за всё время) или целое число 1-90 дней.
Опционально можно добавить параметр access_token для безопасности Server2Server.
Примеры:
Предполагаем, что вы реализовали API (через POST запрос) по адресу https://example.com/aitarget/api/stats и выбрали в качестве параметра безопасности access_token=top_secret (впоследствии может меняться).
Случай №1
Допустим нам необходимо получить суммарные (time_increment='all_days') данные по метрикам (данные метрики задаются на стороне example.com) field1и field2 в период с 2017-08-01 по 2017-08-10 по объектам Facebook с идентификаторами 123456 и 654321. Тогда Aitarget будет выполнять CURL запрос вида:
curl 'https://example.com/aitarget/api/stats' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json' --data 'ids[0]=123456&ids[1]=654321&fields[0]=field1&fields[1]=field2&date_start=201 7-08-01&date_stop=2017-08-10&time_increment=all_days&access_token=top_secret' --compressed
Ожидая получить в ответ JSON:
{
"123456": {
"data": [
{
"date_start": "2017-08-01",
"date_stop": "2017-08-10",
"field1": 35,
"field2": 1.5
}
]
},
"654321": {
"data": [
{
"date_start": "2017-08-01",
"date_stop": "2017-08-10",
"field1": 8,
"field2": 10.5
}
]
}
}
Случай №2
Допустим нам необходимо получить данные по метрикам(данные метрики задаются на стороне example.com)field1и field2в период с 2017-08-01 по 2017-08-03 по объектам Facebook с идентификаторами 123456 и 654321 в разбивке по каждому дню. Тогда Aitarget будет выполнять CURL запрос вида:
curl 'https://example.com/aitarget/api/stats' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json' --data 'ids[0]=123456&ids[1]=654321&fields[0]=field1&fields[1]=field2&date_start=201 7-08-01&date_stop=2017-08-03&time_increment=1&access_token=top_secret' --compressed
Ожидая получить в ответ JSON:
{
"123456": {
"data": [
{
"date_start": "2017-08-01",
"date_stop": "2015-08-01",
"field1": 35,
"field2": 1.5
},
{
"date_start": "2017-08-02",
"date_stop": "2017-08-02",
"field1": 5,
"field2": 0.5
},
{
"date_start": "2017-08-01",
"date_stop": "2017-08-01",
"field1": 500,
"field2": 110.5
}
]
},
"654321": {
"data": [
{
"date_start": "2017-08-01",
"date_stop": "2017-08-01",
"field1": 350,
"field2": 221.5
},
{
"date_start": "2017-08-02",
"date_stop": "2017-08-02",
"field1": 53,
"field2": 330.5
},
{
"date_start": "2017-08-03",
"date_stop": "2017-08-03",
"field1": 50,
"field2": 60.5
}
]
}
}
Случай №3
Допустим нам необходимо получить данные по метрикам (данные метрики задаются на стороне example.com) field1и field2 за Facebook с идентификаторами 123456 и 654321 за последний час (date_preset=last_hour), те если сейчас 2017-09-01 14:40, то с 14:00 до текущего момента. Тогда Aitarget будет выполнять CURL запрос вида:
curl 'https://example.com/aitarget/api/stats' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json' --data 'ids[0]=123456&ids[1]=654321&fields[0]=field1&fields[1]=field2&date_preset=la st_hour&access_token=top_secret' --compressed
Ожидая получить в ответ JSON:
{
"123456": {
"data": [
{
"date_start": "2017-09-01",
"date_stop": "2017-09-01",
"field1": 35,
"field2": 1.5
}
]
},
"654321": {
"data": [
{
"date_start": "2017-09-01",
"date_stop": "2017-09-01",
"field1": 8,
"field2": 10.5
}
]
}
}
Комментарии
0 комментариев
Войдите в службу, чтобы оставить комментарий.