ПланФикс API analitic.getData: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) (Новая страница: «Получение данных аналитики прикрепленной действием. Список доступных аналитик получают ...») |
Seva (обсуждение | вклад) Нет описания правки |
||
Строка 21: | Строка 21: | ||
|- | |- | ||
|} | |} | ||
Допускается одним запросом получать данные от нескольких аналитик сразу. Если в запросе был передан идентификатор несуществующей аналитики, то будет возвращена пустая аналитика, ошибка при этом не будет генерироваться. | |||
Ответ при успешном выполнении запроса: | |||
<source lang="xml"> | |||
<?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> | |||
<analiticData/> | |||
<analiticData> | |||
<key></key> | |||
<itemData> | |||
<id></id> | |||
<name></name> | |||
<value></value> | |||
</itemData> | |||
<itemData> | |||
<id></id> | |||
<name></name> | |||
<value></value> | |||
</itemData> | |||
<!-- ... --> | |||
</analiticData> | |||
<!-- ... --> | |||
</analiticDatas> | |||
</response> | |||
</source> | |||
{| class="wikitable" style="margin-top: 1em; width:100% " | |||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | |||
|- | |||
|analiticDatas || || список запрошенных аналитик || | |||
|- | |||
|analiticData || || узел описывающий данные, которые содержит аналитика || | |||
|- | |||
|analiticData.key || int || идентификатор данных || | |||
|- | |||
|analiticData.itemData || || узел описывающие запись с данными в аналитике || | |||
|- | |||
|itemData.id || int || идентификатор || | |||
|- | |||
|itemData.name || string || имя поля || | |||
|- | |||
|itemData.value || string || значение || | |||
|- | |||
|} | |||
В противном случае будет возвращен ответ с ошибкой: | |||
<source lang="xml"> | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<response status="error"> | |||
<code></code> | |||
</response> | |||
</source> | |||
== Перейти == | |||
*[[ПланФикс API:Аналитика]] | |||
*[[Коды ошибок]] | |||
*[[Список функций]] |
Версия от 15:43, 21 декабря 2010
Получение данных аналитики прикрепленной действием. Список доступных аналитик получают из списка действий. Формат запроса:
<?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) | ключ сесии | выдается в результате прохождения аутентификации |
analitic.id | 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>
<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 | идентификатор | |
itemData.name | string | имя поля | |
itemData.value | string | значение |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>