Перейти к основному содержанию
GET
/
v1
/
crm
/
metrics
/
clients
cURL
curl --request GET \
  --url https://api.example.com/v1/crm/metrics/clients/
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "agreement_id": "<string>",
      "phone": "<string>",
      "ticks": [
        {
          "id": 123,
          "tick": 123,
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "iin": "<string>",
      "bin": "<string>",
      "prediction": "<string>",
      "prediction_period": "<string>",
      "transaction": "<string>",
      "transaction_debt": "<string>",
      "debt": "<string>",
      "debt_period": "<string>",
      "balance": "<string>",
      "bonus": {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "amount": "<string>"
      },
      "type": 0,
      "avatar": "<string>",
      "signed": true,
      "sign_date": "2023-12-25",
      "sign_expires": "2023-12-25",
      "email": "jsmith@example.com",
      "legal_type": 0,
      "extra": "<unknown>"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Параметры запроса

end_at
string
обязательно
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

pageSize
integer

Number of results to return per page.

A search term.

start_at
string
обязательно

Ответ

200 - application/json
count
integer
обязательно
Пример:

123

results
object[]
обязательно
next
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=2"