POST api/analytics/DynamicFriends

Получение сгруппированных помесячных данных по году, по работе механики "приведи друга"

Request Information

URI Parameters

None.

Body Parameters

DynamicFriendsRequest
NameDescriptionTypeAdditional information
Year

Входной фильтр: год, за который нужно вернуть данные

integer

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Year": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<DynamicFriendsRequest 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>
  <Year>1</Year>
</DynamicFriendsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DynamicFriendsResponse
NameDescriptionTypeAdditional information
Data

Collection of DynamicFriendsDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "Id": 1,
      "ProcYear": 1,
      "ProcMonth": 64,
      "Clients": 1,
      "CountActionDone": 1,
      "PercentAction": 1.0,
      "GainDone": 1.0,
      "BonusAdded": 1.0,
      "BonusRedeemed": 1.0,
      "BonusBurn": 1.0
    },
    {
      "Id": 1,
      "ProcYear": 1,
      "ProcMonth": 64,
      "Clients": 1,
      "CountActionDone": 1,
      "PercentAction": 1.0,
      "GainDone": 1.0,
      "BonusAdded": 1.0,
      "BonusRedeemed": 1.0,
      "BonusBurn": 1.0
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<DynamicFriendsResponse 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>
    <DynamicFriendsResponse.DynamicFriendsDataRow>
      <BonusAdded>1</BonusAdded>
      <BonusBurn>1</BonusBurn>
      <BonusRedeemed>1</BonusRedeemed>
      <Clients>1</Clients>
      <CountActionDone>1</CountActionDone>
      <GainDone>1</GainDone>
      <Id>1</Id>
      <PercentAction>1</PercentAction>
      <ProcMonth>64</ProcMonth>
      <ProcYear>1</ProcYear>
    </DynamicFriendsResponse.DynamicFriendsDataRow>
    <DynamicFriendsResponse.DynamicFriendsDataRow>
      <BonusAdded>1</BonusAdded>
      <BonusBurn>1</BonusBurn>
      <BonusRedeemed>1</BonusRedeemed>
      <Clients>1</Clients>
      <CountActionDone>1</CountActionDone>
      <GainDone>1</GainDone>
      <Id>1</Id>
      <PercentAction>1</PercentAction>
      <ProcMonth>64</ProcMonth>
      <ProcYear>1</ProcYear>
    </DynamicFriendsResponse.DynamicFriendsDataRow>
  </Data>
</DynamicFriendsResponse>