# offers (records)

| Required permit | Rate limit tokens cost |
| --- | --- |
| Reporting:Api:Report:Offers | 1 |

This report allows you to get information about offers in your loyalty club.


## Fields

### id

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-done"/> | <Icon icon="material-outline-highlight_off"/> |

Offer ID.

### loyalty_club_id

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-done"/> (via `X-Customer` header) | <Icon icon="material-outline-highlight_off"/> |

ID of loyalty club.

### clicks_count

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of clicks done on offer.

### grants_count

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of times when the offer was granted to a member.

Note that not all offer types are grantable.

### likes_count

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of times the offer was liked.

### seen_count

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of times the offer was seen.

Seen is counted by checking how many times the offer image was downloaded.

### usages_count

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer| <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of times the offer has been used.

### members_count_with_click

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of members which clicked on offer at least 1 time.

### members_count_with_grant

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of members to which the offer was granted at least 1 time.

### members_count_with_seen

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of members which seen the offer at least 1 time.

### members_count_with_usage

| Type | Filterable | Can change? |
| --- | --- | --- |
| Integer | <Icon icon="material-outline-highlight_off"/> | <Icon icon="material-outline-done"/> |

Number of members which used the offer at least 1 time.

## Query without aggregations

Query returns list of sendings.

```json
{
    "records": [
        {
          "id": 42,
          "loyalty_club_id": 43,
          "clicks_count": 2,
          "grants_count": 0,
          "likes_count": 3,
          "seen_count": 10,
          "usages_count": 2,
          "members_count_with_click": 1,
          "members_count_with_grant": 0,
          "members_count_with_seen": 2,
          "members_count_with_usage": 2
        }
    ],
    "pagination": {
        "next_page_info": "CNOW-AE"
    },
    "result_type": "records"
}
```