POST api/analytics/Dynamic
Получение данных по месячной динамике
Request Information
URI Parameters
None.
Body Parameters
DynamicRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Partner |
Идентификатор партнера |
integer |
None. |
| PosCode |
Код ТТ |
string |
None. |
| Year |
Год за который выводятся данные |
integer |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Partner": 1,
"PosCode": "sample string 1",
"Year": 1,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 2"
}
application/xml, text/xml
Sample:
<DynamicRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.AnalyticsRequest"> <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator> <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <Partner>1</Partner> <PosCode>sample string 1</PosCode> <Year>1</Year> </DynamicRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DynamicResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Dynamic |
Коллекция для динамики среднего чека, кол-ва клиентов, выручки, кол-ва возвратов |
Collection of DynamicPeriod |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Dynamic": [
{
"Purchases": 1,
"NewClients": 2,
"RefundSum": 3.0,
"Gain": 4.0,
"AvgCheque": 5.0,
"Refunds": 6,
"ClientWithPurchases": 7,
"ClientWithRedeem": 8,
"ClientWithMobile": 9,
"Month": 64,
"Year": 11
},
{
"Purchases": 1,
"NewClients": 2,
"RefundSum": 3.0,
"Gain": 4.0,
"AvgCheque": 5.0,
"Refunds": 6,
"ClientWithPurchases": 7,
"ClientWithRedeem": 8,
"ClientWithMobile": 9,
"Month": 64,
"Year": 11
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
Sample:
<DynamicResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.AnalyticsResponse">
<ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
<Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
<Dynamic>
<DynamicPeriod>
<AvgCheque>5</AvgCheque>
<ClientWithMobile>9</ClientWithMobile>
<ClientWithPurchases>7</ClientWithPurchases>
<ClientWithRedeem>8</ClientWithRedeem>
<Gain>4</Gain>
<Month>64</Month>
<NewClients>2</NewClients>
<Purchases>1</Purchases>
<RefundSum>3</RefundSum>
<Refunds>6</Refunds>
<Year>11</Year>
</DynamicPeriod>
<DynamicPeriod>
<AvgCheque>5</AvgCheque>
<ClientWithMobile>9</ClientWithMobile>
<ClientWithPurchases>7</ClientWithPurchases>
<ClientWithRedeem>8</ClientWithRedeem>
<Gain>4</Gain>
<Month>64</Month>
<NewClients>2</NewClients>
<Purchases>1</Purchases>
<RefundSum>3</RefundSum>
<Refunds>6</Refunds>
<Year>11</Year>
</DynamicPeriod>
</Dynamic>
</DynamicResponse>