POST api/analytics/ReactivationRules

Получение аналитической информации по результатам работы правил реактивации, по году или за всё время

Request Information

URI Parameters

None.

Body Parameters

ReactivationRulesRequest
NameDescriptionTypeAdditional 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

Sample: 
{
  "ReactivationRule": 1,
  "Year": 1,
  "Month": 64,
  "AllYear": true,
  "BegMonth": 64,
  "EndMonth": 64,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample: 
<ReactivationRulesRequest 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>
</ReactivationRulesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReactivationRulesResponse
NameDescriptionTypeAdditional 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.
RulesData

Массив с данными

 Collection of ReactivationRulesRulesDataRow

None.
RulesTry

Количество попыток на правиле

 Collection of ReactivationRulesRulesTryRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

Сообщение об ошибке

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ClientsIn": 1,
  "ClientsOutWithPurchase": 1,
  "ClientsOutNoPurhcase": 1,
  "Gain": 1.0,
  "Purchases": 1,
  "AvgCheque": 1.0,
  "PercentOutWithPurchase": 1.0,
  "PercentOutNoPurchase": 1.0,
  "RulesData": [
    {
      "Id": 1,
      "ReactivationRule": 1,
      "ReactivationRuleName": "sample string 1",
      "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,
      "ReactivationRule": 1,
      "ReactivationRuleName": "sample string 1",
      "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
    }
  ],
  "RulesTry": [
    {
      "Id": 1,
      "ReactivationRule": 1,
      "CountsTry": 64
    },
    {
      "Id": 1,
      "ReactivationRule": 1,
      "CountsTry": 64
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<ReactivationRulesResponse 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>
  <PercentOutNoPurchase>1</PercentOutNoPurchase>
  <PercentOutWithPurchase>1</PercentOutWithPurchase>
  <Purchases>1</Purchases>
  <RulesData>
    <ReactivationRulesResponse.ReactivationRulesRulesDataRow>
      <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>
      <Purchases>1</Purchases>
      <ReactivationRule>1</ReactivationRule>
      <ReactivationRuleName>sample string 1</ReactivationRuleName>
      <Redeemed>1</Redeemed>
    </ReactivationRulesResponse.ReactivationRulesRulesDataRow>
    <ReactivationRulesResponse.ReactivationRulesRulesDataRow>
      <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>
      <Purchases>1</Purchases>
      <ReactivationRule>1</ReactivationRule>
      <ReactivationRuleName>sample string 1</ReactivationRuleName>
      <Redeemed>1</Redeemed>
    </ReactivationRulesResponse.ReactivationRulesRulesDataRow>
  </RulesData>
  <RulesTry>
    <ReactivationRulesResponse.ReactivationRulesRulesTryRow>
      <CountsTry>64</CountsTry>
      <Id>1</Id>
      <ReactivationRule>1</ReactivationRule>
    </ReactivationRulesResponse.ReactivationRulesRulesTryRow>
    <ReactivationRulesResponse.ReactivationRulesRulesTryRow>
      <CountsTry>64</CountsTry>
      <Id>1</Id>
      <ReactivationRule>1</ReactivationRule>
    </ReactivationRulesResponse.ReactivationRulesRulesTryRow>
  </RulesTry>
</ReactivationRulesResponse>