POST api/analytics/GainStructure
Получение аналитических данных по выручке в программе лояльности в разрезе структуры и активности клиентской базы
Request Information
URI Parameters
None.
Body Parameters
GainStructureRequestName | Description | Type | Additional information |
---|---|---|---|
Partner |
Идентификатор партнера |
integer |
None. |
PosCode |
Код торговой точки |
string |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "Partner": 1, "PosCode": "sample string 1", "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
<GainStructureRequest 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> </GainStructureRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
GainStructureResponseName | Description | Type | Additional information |
---|---|---|---|
Less25Gain |
Выручка клиентов, возраст которых менее 25 лет |
decimal number |
None. |
From2To35Gain |
Выручка клиентов, возраст которых более 25 и менее 35 лет |
decimal number |
None. |
From3To45Gain |
Выручка клиентов, возраст которых более 35 и менее 45 лет |
decimal number |
None. |
More45Gain |
Выручка клиентов, возраст которых более 45 лет |
decimal number |
None. |
UnknowAgeGain |
Выручка клиентов, возраст которых неизвестен |
decimal number |
None. |
BirthdayRuleGain |
30-ти дневная выручка клиентов, с момента отклика на акцию День Рождения |
decimal number |
None. |
BirthdayRuleWithPurchases |
Количество клиентов, откликнувшихся на акцию День Рождения |
integer |
None. |
NoBirthdayRuleClients |
Количество клиентов, которые не откликнулись на акцию День Рождения или не указали дату рождения |
integer |
None. |
BirthdayRuleResponse |
% отклика по акции День рождения, за все вермя |
decimal number |
None. |
BirthdayRuleGainTotal |
Выручка клиентов, которые хотя бы раз откликались на акцию День Рождения, за все время |
decimal number |
None. |
BirthdayRuleGainTotalPercent |
Процент выручки от общей выручки, которую совершили клиенты которые хотя бы раз откликались на акцию День Рождения |
decimal number |
None. |
ManGain |
Выручка мужчин |
decimal number |
None. |
WomanGain |
Выручка женщин |
decimal number |
None. |
UnknowGenderGain |
Выручка клиентов, пол которых неизвестен |
decimal number |
None. |
WithAppGain |
Выручка клиентов, которые установили мобильное приложение |
decimal number |
None. |
NoAppGain |
Выручка клиентов, которые не установили мобильное приложение |
decimal number |
None. |
IosGain |
Выручка клиентов, с установленными приложениями ios |
decimal number |
None. |
AndroidGain |
Выручка клиентов, с установленными приложениями android |
decimal number |
None. |
NoAppAvgCheque |
Средний чек клиентов без мобильных приложений |
decimal number |
None. |
WithAppAvgCheque |
Средний чек клиентов с мобильными приложениям |
decimal number |
None. |
NoAppWithRedeemPercent |
% людей с хотя бы одним списанием среди клиентов без мобильных приложений |
decimal number |
None. |
WithAppWithRedeemPercent |
% людей с хотя бы одним списанием среди клиентов с мобильными приложениями |
decimal number |
None. |
ZeroRedeemGain |
Выручка клиентов, которые ниразу не списывали бонусы |
decimal number |
None. |
OneRedeemGain |
Выручка клиентов, которые 1 раз списывали бонусы |
decimal number |
None. |
From2To5RedeemGain |
Выручка клиентов, с 2-5 операциями списания бонусов |
decimal number |
None. |
From6To10RedeemGain |
Выручка клиентов, с 6-10 операциями списания бонусов |
decimal number |
None. |
More1RredeemGain |
Выручка клиентов, с 11 и более операциями списания |
decimal number |
None. |
WithRedeemGain |
Выручка клиентов с одним и более списанием |
decimal number |
None. |
WithRedeemGainOnClient |
Выручка на клиента из тех кто совершил одно и более списаний |
decimal number |
None. |
NoRedeemGainOnClient |
Выручка на клиента из тех кто не совершил ни единого списания |
decimal number |
None. |
AvgChequeNoRedeem |
Средний чек клиентов, которые не списывали бонусы |
decimal number |
None. |
AvgChequeWithRedeem |
Средний чек клиентов, которые списывают бонусы |
decimal number |
None. |
NoRedeemCheques |
Количество чеков без списания бонусов |
integer |
None. |
WithRedeemCheques |
Количество чеков со списанием бонусов |
integer |
None. |
NoRedeemChequesPercent |
% чеков от общего кол-ва в которых не было списания бонусов |
decimal number |
None. |
WithRedeemChequesPercent |
% чеков от общего кол-ва в которых было списание бонусов |
decimal number |
None. |
ZeroRedeemClients |
Количество клиентов, которые ниразу не списывали бонусы |
integer |
None. |
OneRedeemClients |
Количество клиентов, которые 1 раз списывали бонусы |
integer |
None. |
From2To5RedeemClients |
Количество клиентов, с 2-5 операциями списания бонусов |
integer |
None. |
From6To10RedeemClients |
Количество клиентов, с 6-10 операциями списания бонусов |
integer |
None. |
More11RedeemClients |
Количество клиентов, с 11 и более операциями списания |
integer |
None. |
Gain |
Общая выручка |
decimal number |
None. |
RefundSum |
Сумма возвратов |
decimal number |
None. |
AvgCheque |
Средний чек |
decimal number |
None. |
GainOnClient |
Выручка на клиента |
decimal number |
None. |
Purchases |
Количество покупок |
integer |
None. |
Refunds |
Количество возвратов |
integer |
None. |
GainText |
Выручка текстом |
string |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Less25Gain": 1.0, "From2To35Gain": 1.0, "From3To45Gain": 1.0, "More45Gain": 1.0, "UnknowAgeGain": 1.0, "BirthdayRuleGain": 1.0, "BirthdayRuleWithPurchases": 1, "NoBirthdayRuleClients": 1, "BirthdayRuleResponse": 1.0, "BirthdayRuleGainTotal": 1.0, "BirthdayRuleGainTotalPercent": 1.0, "ManGain": 1.0, "WomanGain": 1.0, "UnknowGenderGain": 1.0, "WithAppGain": 1.0, "NoAppGain": 1.0, "IosGain": 1.0, "AndroidGain": 1.0, "NoAppAvgCheque": 1.0, "WithAppAvgCheque": 1.0, "NoAppWithRedeemPercent": 1.0, "WithAppWithRedeemPercent": 1.0, "ZeroRedeemGain": 1.0, "OneRedeemGain": 1.0, "From2To5RedeemGain": 1.0, "From6To10RedeemGain": 1.0, "More1RredeemGain": 1.0, "WithRedeemGain": 1.0, "WithRedeemGainOnClient": 1.0, "NoRedeemGainOnClient": 1.0, "AvgChequeNoRedeem": 1.0, "AvgChequeWithRedeem": 1.0, "NoRedeemCheques": 1, "WithRedeemCheques": 1, "NoRedeemChequesPercent": 1.0, "WithRedeemChequesPercent": 1.0, "ZeroRedeemClients": 1, "OneRedeemClients": 1, "From2To5RedeemClients": 1, "From6To10RedeemClients": 1, "More11RedeemClients": 1, "Gain": 1.0, "RefundSum": 1.0, "AvgCheque": 1.0, "GainOnClient": 1.0, "Purchases": 1, "Refunds": 1, "GainText": "sample string 1", "ErrorCode": 2, "Message": "sample string 3" }
application/xml, text/xml
<GainStructureResponse 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">2</ErrorCode> <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</Message> <AndroidGain>1</AndroidGain> <AvgCheque>1</AvgCheque> <AvgChequeNoRedeem>1</AvgChequeNoRedeem> <AvgChequeWithRedeem>1</AvgChequeWithRedeem> <BirthdayRuleGain>1</BirthdayRuleGain> <BirthdayRuleGainTotal>1</BirthdayRuleGainTotal> <BirthdayRuleGainTotalPercent>1</BirthdayRuleGainTotalPercent> <BirthdayRuleResponse>1</BirthdayRuleResponse> <BirthdayRuleWithPurchases>1</BirthdayRuleWithPurchases> <From2To35Gain>1</From2To35Gain> <From2To5RedeemClients>1</From2To5RedeemClients> <From2To5RedeemGain>1</From2To5RedeemGain> <From3To45Gain>1</From3To45Gain> <From6To10RedeemClients>1</From6To10RedeemClients> <From6To10RedeemGain>1</From6To10RedeemGain> <Gain>1</Gain> <GainOnClient>1</GainOnClient> <GainText>sample string 1</GainText> <IosGain>1</IosGain> <Less25Gain>1</Less25Gain> <ManGain>1</ManGain> <More11RedeemClients>1</More11RedeemClients> <More1RredeemGain>1</More1RredeemGain> <More45Gain>1</More45Gain> <NoAppAvgCheque>1</NoAppAvgCheque> <NoAppGain>1</NoAppGain> <NoAppWithRedeemPercent>1</NoAppWithRedeemPercent> <NoBirthdayRuleClients>1</NoBirthdayRuleClients> <NoRedeemCheques>1</NoRedeemCheques> <NoRedeemChequesPercent>1</NoRedeemChequesPercent> <NoRedeemGainOnClient>1</NoRedeemGainOnClient> <OneRedeemClients>1</OneRedeemClients> <OneRedeemGain>1</OneRedeemGain> <Purchases>1</Purchases> <RefundSum>1</RefundSum> <Refunds>1</Refunds> <UnknowAgeGain>1</UnknowAgeGain> <UnknowGenderGain>1</UnknowGenderGain> <WithAppAvgCheque>1</WithAppAvgCheque> <WithAppGain>1</WithAppGain> <WithAppWithRedeemPercent>1</WithAppWithRedeemPercent> <WithRedeemCheques>1</WithRedeemCheques> <WithRedeemChequesPercent>1</WithRedeemChequesPercent> <WithRedeemGain>1</WithRedeemGain> <WithRedeemGainOnClient>1</WithRedeemGainOnClient> <WomanGain>1</WomanGain> <ZeroRedeemClients>1</ZeroRedeemClients> <ZeroRedeemGain>1</ZeroRedeemGain> </GainStructureResponse>