# Get revenue statistics

The method allows you to get statistics on revenue.

Endpoint: GET /locations/{location_id}/analytics/loyalty_programs/income
Version: 1.0.0
Security: BearerPartnerUser

## Security:

  - `BearerPartnerUser` (unknown)
    http bearer Bearer {PartnerToken}, User {UserToken}

## Path parameters:

  - `location_id` (number, required)
    location ID

## Query parameters:

  - `date_to` (string, required)
    Period end date

  - `date_from` (string, required)
    Period start date

  - `loyalty_program_id` (string, required)
    Loyalty Program ID

## Header parameters:

  - `Accept` (string, required)
    application/vnd.api.v2+json

  - `Content-Type` (string, required)
    application/json

  - `Authorization` (string, required)
    Bearer bearer_token, User user_token

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `success` (boolean)
    Execution success status

  - `data` (object)
    Object with data

  - `data.income_stats` (object)
    revenue statistics

  - `data.income_stats.new` (object)
    New clients

  - `data.income_stats.new.all_sum` (integer)
    Revenue from new customers

  - `data.income_stats.new.returned_sum` (integer)
    Revenue from returning customers

  - `data.income_stats.old` (object)
    Old clients

  - `data.income_stats.old.all_sum` (integer)
    Revenue from old customers

  - `data.income_stats.old.returned_sum` (integer)
    Revenue from returning customers

  - `data.income_stats.total` (object)
    Total amount

  - `data.income_stats.total.all_sum` (integer)
    Revenue for all customers

  - `data.income_stats.total.returned_sum` (integer)
    Revenue from returning customers

  - `data.currency` (object)
    Currency

  - `data.currency.id` (integer)
    Currency identifier

  - `data.currency.iso` (string)
    Name in the ISO system

  - `data.currency.name` (string)
    Full title

  - `data.currency.symbol` (string)
    Currency symbol

  - `data.currency.is_symbol_after_amount` (boolean)

  - `data.income_stats_by_day` (array)
    Revenue statistics by day

  - `data.income_stats_by_day.date` (string)
    date

  - `data.income_stats_by_day.new_sum` (integer)
    Revenue from new customers

  - `data.income_stats_by_day.old_sum` (integer)
    Revenue from old customers

  - `meta` (array)
    Metadata (empty array)

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `success` (boolean)
    Response status.
    Example: false

  - `data` (object | null)
    Response data.
    Example: null

  - `meta` (object)
    Additional response data.

  - `meta.message` (string)
    Error message.
    Example: Authentication needed.

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `success` (boolean)
    Response status.
    Example: false

  - `data` (object | null)
    Response data.
    Example: null

  - `meta` (object)
    Additional response data.

  - `meta.message` (string)
    Error message.
    Example: Access denied.

## Response 404:

  - `404` (unknown)
    Not Found

## Response 404 fields (application/json):

  - `success` (boolean)
    Response status.
    Example: false

  - `data` (object | null)
    Response data.
    Example: null

  - `meta` (object | array)
    Additional response data (empty object or empty array)
    Example: {}

