ПланФикс API analitic.getData
Материал из Planfix
Получение данных аналитики прикрепленной действием. Список доступных аналитик получают из списка действий. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="analitic.getData">
<account></account>
<sid></sid>
<analiticKeys>
<key></key>
<key></key>
<!-- ... -->
</analiticKeys>
<signature></signature>
</request>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| sid | string(32) | ключ сесии | выдается в результате прохождения аутентификации |
| analiticKeys.key | int | идентификатор строки данных аналитики |
Допускается одним запросом получать данные сразу нескольких добавленных аналитик. Если в запросе был передан идентификатор несуществующей аналитики, то будет возвращена пустая аналитика, ошибка при этом не будет генерироваться.
Ответ при успешном выполнении запроса:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<analiticDatas>
<analiticData>
<key></key>
<itemData>
<id></id>
<name></name>
<value></value>
</itemData>
<itemData>
<id></id>
<name></name>
<value></value>
</itemData>
<!-- ... -->
</analiticData>
<key></key>
<analiticData>
</analiticData>
<analiticData>
<key></key>
<itemData>
<id></id>
<name></name>
<value></value>
</itemData>
<itemData>
<id></id>
<name></name>
<value></value>
</itemData>
<!-- ... -->
</analiticData>
<!-- ... -->
</analiticDatas>
</response>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| analiticDatas | список запрошенных аналитик | ||
| analiticData | узел описывающий данные, которые содержит аналитика | ||
| analiticData.key | int | идентификатор данных | |
| analiticData.itemData | узел описывающие запись с данными в аналитике | ||
| itemData.id | int | идентификатор, он равен field.id | |
| itemData.name | string | имя поля | |
| itemData.value | string | значение |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>