POST api/analytics/FavoriteProduct
Получение аналитической информации по Любимому продукту, помесячно, с входными фильтрами, по клиенту или всем клиентам.
Request Information
URI Parameters
None.
Body Parameters
FavoriteProductRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ProcYear |
Год, за который выводим данные |
integer |
None. |
| Client |
Фильтр: идентификатор клиент по которому строим аналитику |
integer |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ProcYear": 1,
"Client": 1,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 1"
}
application/xml, text/xml
Sample:
<FavoriteProductRequest 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> <Client>1</Client> <ProcYear>1</ProcYear> </FavoriteProductRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
FavoriteProductResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data |
Итоговые данные |
Collection of FavoriteProductDataRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"Id": 64,
"ProcYear": 1,
"ProcMonth": 64,
"CountClients": 1,
"CountClientsConfirm": 1,
"CountItemsSelected": 1,
"CountChequesWithDiscount": 1,
"Gain": 1.0,
"CountHits": 1,
"AllCountCheques": 1,
"AllGain": 1.0,
"PersentCheques": 1.0,
"PersentGain": 1.0,
"CountHitsConfirm": 1,
"ConfirmOnClient": 1.0,
"CountOffers": 1
},
{
"Id": 64,
"ProcYear": 1,
"ProcMonth": 64,
"CountClients": 1,
"CountClientsConfirm": 1,
"CountItemsSelected": 1,
"CountChequesWithDiscount": 1,
"Gain": 1.0,
"CountHits": 1,
"AllCountCheques": 1,
"AllGain": 1.0,
"PersentCheques": 1.0,
"PersentGain": 1.0,
"CountHitsConfirm": 1,
"ConfirmOnClient": 1.0,
"CountOffers": 1
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
Sample:
<FavoriteProductResponse 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>
<Data>
<FavoriteProductResponse.FavoriteProductDataRow>
<AllCountCheques>1</AllCountCheques>
<AllGain>1</AllGain>
<ConfirmOnClient>1</ConfirmOnClient>
<CountChequesWithDiscount>1</CountChequesWithDiscount>
<CountClients>1</CountClients>
<CountClientsConfirm>1</CountClientsConfirm>
<CountHits>1</CountHits>
<CountHitsConfirm>1</CountHitsConfirm>
<CountItemsSelected>1</CountItemsSelected>
<CountOffers>1</CountOffers>
<Gain>1</Gain>
<Id>64</Id>
<PersentCheques>1</PersentCheques>
<PersentGain>1</PersentGain>
<ProcMonth>64</ProcMonth>
<ProcYear>1</ProcYear>
</FavoriteProductResponse.FavoriteProductDataRow>
<FavoriteProductResponse.FavoriteProductDataRow>
<AllCountCheques>1</AllCountCheques>
<AllGain>1</AllGain>
<ConfirmOnClient>1</ConfirmOnClient>
<CountChequesWithDiscount>1</CountChequesWithDiscount>
<CountClients>1</CountClients>
<CountClientsConfirm>1</CountClientsConfirm>
<CountHits>1</CountHits>
<CountHitsConfirm>1</CountHitsConfirm>
<CountItemsSelected>1</CountItemsSelected>
<CountOffers>1</CountOffers>
<Gain>1</Gain>
<Id>64</Id>
<PersentCheques>1</PersentCheques>
<PersentGain>1</PersentGain>
<ProcMonth>64</ProcMonth>
<ProcYear>1</ProcYear>
</FavoriteProductResponse.FavoriteProductDataRow>
</Data>
</FavoriteProductResponse>