POST api/analytics/DynamicReactivation
Получение аналитической информации о работе сервиса реактивации, с входными фильтрами, в разбивке по месяцам года
Request Information
URI Parameters
None.
Body Parameters
DynamicReactivationRequestName | Description | Type | Additional information |
---|---|---|---|
ReactivationRule |
Входной фильтр: идентификатор правила реактивации |
integer |
None. |
Year |
Входной фильтр: год, за который нужно вернуть данные |
integer |
None. |
Month |
Входной фильтр: месяц, за который нужно вернуть данные |
byte |
None. |
AllYear |
Входной фильтр: признак, что данные нужно вернуть за все года |
boolean |
None. |
BegMonth |
Входной фильтр: начальный месяц периода |
byte |
None. |
EndMonth |
Входной фильтр: конечный месяц периода |
byte |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "ReactivationRule": 1, "Year": 1, "Month": 64, "AllYear": true, "BegMonth": 64, "EndMonth": 64, "Operator": 1, "Token": 1, "SiteCode": "sample string 1" }
application/xml, text/xml
<DynamicReactivationRequest 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 1</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <AllYear>true</AllYear> <BegMonth>64</BegMonth> <EndMonth>64</EndMonth> <Month>64</Month> <ReactivationRule>1</ReactivationRule> <Year>1</Year> </DynamicReactivationRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
DynamicReactivationResponseName | Description | Type | Additional information |
---|---|---|---|
ClientsIn |
Общее количество клиентов, которые попали на реактивацию, за период |
integer |
None. |
ClientsOutWithPurchase |
Общее количество клиентов, которые вышли из реактивации с покупками, за период |
integer |
None. |
ClientsOutNoPurhcase |
Общее количество клиентов, которые вышли из реактивации без покупок, за период |
integer |
None. |
Gain |
Общая выручка клиентов, которые вышли из реактивации с покупками, за период |
decimal number |
None. |
Purchases |
Общее количество покупок клиентов, которые вышли из реактивации с покупками, за период |
integer |
None. |
AvgCheque |
Средний чек клиентов, которые вышли из реактивации с покупками, за период |
decimal number |
None. |
PercentOutWithPurchase |
Процент вышедших клиентов, от вошедших на реактивацию, с покупками, за период |
decimal number |
None. |
PercentOutNoPurchase |
Процент вышедших клиентов, от вошедших на реактивацию, БЕЗ покупок, за период |
decimal number |
None. |
MonthClients |
Массив с данными |
Collection of DynamicReactivationMonthClientRow |
None. |
Rules |
Возможные правила для фильтров на графике |
Collection of DynamicReactivationRuleRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "ClientsIn": 1, "ClientsOutWithPurchase": 1, "ClientsOutNoPurhcase": 1, "Gain": 1.0, "Purchases": 1, "AvgCheque": 1.0, "PercentOutWithPurchase": 1.0, "PercentOutNoPurchase": 1.0, "MonthClients": [ { "Id": 1, "ProcMonth": 64, "Added": 1.0, "Redeemed": 1.0, "ClientsIn": 1, "ClientsOutWithpurchase": 1, "ClientsOutNopurhcase": 1, "Gain": 1.0, "Purchases": 1, "AvgCheque": 1.0, "PercentOutWithPurchase": 1.0, "PercentOutNoPurhcase": 1.0 }, { "Id": 1, "ProcMonth": 64, "Added": 1.0, "Redeemed": 1.0, "ClientsIn": 1, "ClientsOutWithpurchase": 1, "ClientsOutNopurhcase": 1, "Gain": 1.0, "Purchases": 1, "AvgCheque": 1.0, "PercentOutWithPurchase": 1.0, "PercentOutNoPurhcase": 1.0 } ], "Rules": [ { "Id": 1, "ReactivationRule": 1, "ReactivationRuleName": "sample string 1" }, { "Id": 1, "ReactivationRule": 1, "ReactivationRuleName": "sample string 1" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<DynamicReactivationResponse 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> <AvgCheque>1</AvgCheque> <ClientsIn>1</ClientsIn> <ClientsOutNoPurhcase>1</ClientsOutNoPurhcase> <ClientsOutWithPurchase>1</ClientsOutWithPurchase> <Gain>1</Gain> <MonthClients> <DynamicReactivationResponse.DynamicReactivationMonthClientRow> <Added>1</Added> <AvgCheque>1</AvgCheque> <ClientsIn>1</ClientsIn> <ClientsOutNopurhcase>1</ClientsOutNopurhcase> <ClientsOutWithpurchase>1</ClientsOutWithpurchase> <Gain>1</Gain> <Id>1</Id> <PercentOutNoPurhcase>1</PercentOutNoPurhcase> <PercentOutWithPurchase>1</PercentOutWithPurchase> <ProcMonth>64</ProcMonth> <Purchases>1</Purchases> <Redeemed>1</Redeemed> </DynamicReactivationResponse.DynamicReactivationMonthClientRow> <DynamicReactivationResponse.DynamicReactivationMonthClientRow> <Added>1</Added> <AvgCheque>1</AvgCheque> <ClientsIn>1</ClientsIn> <ClientsOutNopurhcase>1</ClientsOutNopurhcase> <ClientsOutWithpurchase>1</ClientsOutWithpurchase> <Gain>1</Gain> <Id>1</Id> <PercentOutNoPurhcase>1</PercentOutNoPurhcase> <PercentOutWithPurchase>1</PercentOutWithPurchase> <ProcMonth>64</ProcMonth> <Purchases>1</Purchases> <Redeemed>1</Redeemed> </DynamicReactivationResponse.DynamicReactivationMonthClientRow> </MonthClients> <PercentOutNoPurchase>1</PercentOutNoPurchase> <PercentOutWithPurchase>1</PercentOutWithPurchase> <Purchases>1</Purchases> <Rules> <DynamicReactivationResponse.DynamicReactivationRuleRow> <Id>1</Id> <ReactivationRule>1</ReactivationRule> <ReactivationRuleName>sample string 1</ReactivationRuleName> </DynamicReactivationResponse.DynamicReactivationRuleRow> <DynamicReactivationResponse.DynamicReactivationRuleRow> <Id>1</Id> <ReactivationRule>1</ReactivationRule> <ReactivationRuleName>sample string 1</ReactivationRuleName> </DynamicReactivationResponse.DynamicReactivationRuleRow> </Rules> </DynamicReactivationResponse>