---
title: "Audience"
permalink: "/docs/api-v2/audience"
original_source: "openapi-spec/api-v2.yaml"
---

> **AI agents:** This is the Markdown version of a RevenueCat documentation page. For the complete documentation index, see [llms.txt](https://www.revenuecat.com/docs/llms.txt).

# Audience

## Audience

Operations about audiences.

### Get a list of audiences

`GET /projects/{project_id}/audiences`

Operation ID: `list-audiences`

This endpoint requires the following permission(s): <code>audiences:audiences:read</code>. This endpoint belongs to the <strong>Audiences</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |

**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Audience | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page. Audiences are not paginated, so this is always null. |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Always has the value `audience`. One of: `audience` |
| `id` | string | yes | The id of the audience |
| `project_id` | string | yes | ID of the project to which the audience belongs |
| `customer_list_id` | string | yes | ID of the customer list backing the audience |
| `name` | string | yes | The name of the audience |
| `rules` | AudienceRules | yes | The audience membership rules. A subscriber matches the audience when any group matches (groups are combined with OR); within a group all conditions must match (conditions are combined with AND). |
| `created_at` | integer | yes | The date the audience was created (ms since epoch) |
| `updated_at` | integer | yes | The date the audience was last updated (ms since epoch) |
| `stats` | AudiencePreviewStats | no |  |
| `customer_sample` | array of AudienceSampleItem | no | Sample of customers matching the audience. Only present when requested with `expand=customer_sample`. |
| `used_by` | AudienceUsedBy | no |  |

<details><summary><code>rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `groups` | array of object | yes | The condition groups, combined with OR. |

</details>

<details><summary><code>stats</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `total_customers` | integer | yes |  |
| `active_subscriptions` | integer | yes |  |
| `active_trials` | integer | yes |  |
| `total_revenue` | number | yes | Total revenue in the developer's display currency. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `is_approximate` | boolean | yes | Whether these metrics are approximate. When true, counts and revenue are estimated from a sample rather than exact. |

</details>

<details><summary><code>customer_sample</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_member` |
| `app_user_id` | string | yes |  |
| `app_uuid` | string | yes |  |
| `email` | string | no |  |
| `first_seen_at` | integer | no | Timestamp when the customer was first seen or purchased, in milliseconds since epoch. |
| `last_seen_at` | integer | no | Timestamp when the customer was last seen, in milliseconds since epoch. |
| `status` | string | yes |  |
| `total_spent` | number | yes | Total gross across the subscriber's subscriptions and one-time purchases, in `currency`, or null when no production purchase or exchange rate exists. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `latest_product_name` | string | no | Display name of the most recent non-sandbox subscription or one-time purchase product, or null if none. |

</details>

<details><summary><code>used_by</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_used_by` |
| `targeting_rules` | array of AudienceTargetingRuleReference | yes | Targeting rules that reference this audience |
| `experiments` | array of AudienceExperimentReference | yes | Experiments that reference this audience |

</details>
</details>
### Create an audience

`POST /projects/{project_id}/audiences`

Operation ID: `create-audience`

This endpoint requires the following permission(s): <code>audiences:audiences:read_write</code>. This endpoint belongs to the <strong>Audiences</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |

**Request body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | The name of the audience |
| `rules` | AudienceRules | yes | The audience membership rules. A subscriber matches the audience when any group matches (groups are combined with OR); within a group all conditions must match (conditions are combined with AND). |

<details><summary><code>rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `groups` | array of object | yes | The condition groups, combined with OR. |

<details><summary><code>groups</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conditions` | array of AudienceRuleCondition | yes | The conditions in the group, combined with AND. |

</details>
</details>
**Responses**

- `201` — Success. The audience was created
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `201` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Always has the value `audience`. One of: `audience` |
| `id` | string | yes | The id of the audience |
| `project_id` | string | yes | ID of the project to which the audience belongs |
| `customer_list_id` | string | yes | ID of the customer list backing the audience |
| `name` | string | yes | The name of the audience |
| `rules` | AudienceRules | yes | The audience membership rules. A subscriber matches the audience when any group matches (groups are combined with OR); within a group all conditions must match (conditions are combined with AND). |
| `created_at` | integer | yes | The date the audience was created (ms since epoch) |
| `updated_at` | integer | yes | The date the audience was last updated (ms since epoch) |
| `stats` | AudiencePreviewStats | no |  |
| `customer_sample` | array of AudienceSampleItem | no | Sample of customers matching the audience. Only present when requested with `expand=customer_sample`. |
| `used_by` | AudienceUsedBy | no |  |

<details><summary><code>rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `groups` | array of object | yes | The condition groups, combined with OR. |

<details><summary><code>groups</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conditions` | array of AudienceRuleCondition | yes | The conditions in the group, combined with AND. |

</details>
</details>

<details><summary><code>stats</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `total_customers` | integer | yes |  |
| `active_subscriptions` | integer | yes |  |
| `active_trials` | integer | yes |  |
| `total_revenue` | number | yes | Total revenue in the developer's display currency. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `is_approximate` | boolean | yes | Whether these metrics are approximate. When true, counts and revenue are estimated from a sample rather than exact. |

</details>

<details><summary><code>customer_sample</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_member` |
| `app_user_id` | string | yes |  |
| `app_uuid` | string | yes |  |
| `email` | string | no |  |
| `first_seen_at` | integer | no | Timestamp when the customer was first seen or purchased, in milliseconds since epoch. |
| `last_seen_at` | integer | no | Timestamp when the customer was last seen, in milliseconds since epoch. |
| `status` | string | yes |  |
| `total_spent` | number | yes | Total gross across the subscriber's subscriptions and one-time purchases, in `currency`, or null when no production purchase or exchange rate exists. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `latest_product_name` | string | no | Display name of the most recent non-sandbox subscription or one-time purchase product, or null if none. |

</details>

<details><summary><code>used_by</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_used_by` |
| `targeting_rules` | array of AudienceTargetingRuleReference | yes | Targeting rules that reference this audience |
| `experiments` | array of AudienceExperimentReference | yes | Experiments that reference this audience |

<details><summary><code>targeting_rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `targeting_rule_reference` |
| `id` | string | yes | The id of the targeting rule |
| `display_name` | string | yes | The display name of the targeting rule |
| `state` | string | yes | Whether the targeting rule is currently active One of: `active`, `inactive` |

</details>

<details><summary><code>experiments</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `experiment_reference` |
| `id` | string | yes | The id of the experiment |
| `display_name` | string | yes | The display name of the experiment |
| `status` | string | yes | The status of the experiment One of: `draft`, `running`, `paused`, `stopped` |

</details>
</details>
### Preview audience members

`POST /projects/{project_id}/audiences/actions/preview`

Operation ID: `preview-audience`

This endpoint requires the following permission(s): <code>audiences:audiences:read</code>. This endpoint belongs to the <strong>Audiences</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |

**Request body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `audience_uuid` | string | yes | UUID of the saved audience. |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `rules` | AudienceRules | yes | The audience membership rules. A subscriber matches the audience when any group matches (groups are combined with OR); within a group all conditions must match (conditions are combined with AND). |

<details><summary><code>rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `groups` | array of object | yes | The condition groups, combined with OR. |

</details>
**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_preview` |
| `stats` | AudiencePreviewStats | yes |  |
| `customer_sample` | array of AudienceSampleItem | yes |  |

<details><summary><code>stats</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `total_customers` | integer | yes |  |
| `active_subscriptions` | integer | yes |  |
| `active_trials` | integer | yes |  |
| `total_revenue` | number | yes | Total revenue in the developer's display currency. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `is_approximate` | boolean | yes | Whether these metrics are approximate. When true, counts and revenue are estimated from a sample rather than exact. |

</details>

<details><summary><code>customer_sample</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_member` |
| `app_user_id` | string | yes |  |
| `app_uuid` | string | yes |  |
| `email` | string | no |  |
| `first_seen_at` | integer | no | Timestamp when the customer was first seen or purchased, in milliseconds since epoch. |
| `last_seen_at` | integer | no | Timestamp when the customer was last seen, in milliseconds since epoch. |
| `status` | string | yes |  |
| `total_spent` | number | yes | Total gross across the subscriber's subscriptions and one-time purchases, in `currency`, or null when no production purchase or exchange rate exists. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `latest_product_name` | string | no | Display name of the most recent non-sandbox subscription or one-time purchase product, or null if none. |

</details>
### Get audience filter options

`GET /projects/{project_id}/audiences/filter_options`

Operation ID: `get-audience-filter-options`

Returns the known values for audience rule condition fields whose options are derived from the project's data (attribution fields, price experiments, and custom attributes). Custom attributes are returned as dynamic fields using the format `customAttribute:<key>`; requesting `customAttribute` expands to every known custom attribute. Fields with a fixed set of values (e.g. `country`, `platform`, `status`) are not served by this endpoint. This endpoint requires the following permission(s): <code>audiences:audiences:read</code>. This endpoint belongs to the <strong>Audiences</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `fields` | query | yes | Audience condition fields to load options for. Custom attributes use the field format `customAttribute:<key>`; `customAttribute` alone expands to every known custom attribute. |

**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of AudienceFilterFieldOptions | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page. Filter options are not paginated, so this is always null. |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_filter_field_options` |
| `field` | oneOf | yes | The audience rule condition field these options belong to |
| `options` | array of AudienceFilterOption | yes | The known values for this field |
| `cardinality_exceeded` | boolean | no | Whether additional values exist beyond the stored custom-attribute options. Only present for custom-attribute fields. |

<details><summary><code>options</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_filter_option` |
| `id` | string | yes | The option value to use in an audience rule condition |
| `display_name` | string | yes | The display name of the option |

</details>
</details>
### Get an audience

`GET /projects/{project_id}/audiences/{audience_id}`

Operation ID: `get-audience`

This endpoint requires the following permission(s): <code>audiences:audiences:read</code>. This endpoint belongs to the <strong>Audiences</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `audience_id` | path | yes | ID of the audience |
| `expand` | query | no | Specifies which fields in the response should be expanded. Accepted values are: `stats` (requires `audiences:audiences:read` permission), `customer_sample` (requires `audiences:audiences:read` permission), `used_by` (requires `audiences:audiences:read` permission). |

**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Always has the value `audience`. One of: `audience` |
| `id` | string | yes | The id of the audience |
| `project_id` | string | yes | ID of the project to which the audience belongs |
| `customer_list_id` | string | yes | ID of the customer list backing the audience |
| `name` | string | yes | The name of the audience |
| `rules` | AudienceRules | yes | The audience membership rules. A subscriber matches the audience when any group matches (groups are combined with OR); within a group all conditions must match (conditions are combined with AND). |
| `created_at` | integer | yes | The date the audience was created (ms since epoch) |
| `updated_at` | integer | yes | The date the audience was last updated (ms since epoch) |
| `stats` | AudiencePreviewStats | no |  |
| `customer_sample` | array of AudienceSampleItem | no | Sample of customers matching the audience. Only present when requested with `expand=customer_sample`. |
| `used_by` | AudienceUsedBy | no |  |

<details><summary><code>rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `groups` | array of object | yes | The condition groups, combined with OR. |

<details><summary><code>groups</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conditions` | array of AudienceRuleCondition | yes | The conditions in the group, combined with AND. |

</details>
</details>

<details><summary><code>stats</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `total_customers` | integer | yes |  |
| `active_subscriptions` | integer | yes |  |
| `active_trials` | integer | yes |  |
| `total_revenue` | number | yes | Total revenue in the developer's display currency. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `is_approximate` | boolean | yes | Whether these metrics are approximate. When true, counts and revenue are estimated from a sample rather than exact. |

</details>

<details><summary><code>customer_sample</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_member` |
| `app_user_id` | string | yes |  |
| `app_uuid` | string | yes |  |
| `email` | string | no |  |
| `first_seen_at` | integer | no | Timestamp when the customer was first seen or purchased, in milliseconds since epoch. |
| `last_seen_at` | integer | no | Timestamp when the customer was last seen, in milliseconds since epoch. |
| `status` | string | yes |  |
| `total_spent` | number | yes | Total gross across the subscriber's subscriptions and one-time purchases, in `currency`, or null when no production purchase or exchange rate exists. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `latest_product_name` | string | no | Display name of the most recent non-sandbox subscription or one-time purchase product, or null if none. |

</details>

<details><summary><code>used_by</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_used_by` |
| `targeting_rules` | array of AudienceTargetingRuleReference | yes | Targeting rules that reference this audience |
| `experiments` | array of AudienceExperimentReference | yes | Experiments that reference this audience |

<details><summary><code>targeting_rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `targeting_rule_reference` |
| `id` | string | yes | The id of the targeting rule |
| `display_name` | string | yes | The display name of the targeting rule |
| `state` | string | yes | Whether the targeting rule is currently active One of: `active`, `inactive` |

</details>

<details><summary><code>experiments</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `experiment_reference` |
| `id` | string | yes | The id of the experiment |
| `display_name` | string | yes | The display name of the experiment |
| `status` | string | yes | The status of the experiment One of: `draft`, `running`, `paused`, `stopped` |

</details>
</details>
### Update an audience

`POST /projects/{project_id}/audiences/{audience_id}`

Operation ID: `update-audience`

This endpoint requires the following permission(s): <code>audiences:audiences:read_write</code>. This endpoint belongs to the <strong>Audiences</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `audience_id` | path | yes | ID of the audience |

**Request body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no | The name of the audience |
| `rules` | AudienceRules | no | The audience membership rules. A subscriber matches the audience when any group matches (groups are combined with OR); within a group all conditions must match (conditions are combined with AND). |

<details><summary><code>rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `groups` | array of object | yes | The condition groups, combined with OR. |

<details><summary><code>groups</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conditions` | array of AudienceRuleCondition | yes | The conditions in the group, combined with AND. |

</details>
</details>
**Responses**

- `200` — Success. The audience was updated
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Always has the value `audience`. One of: `audience` |
| `id` | string | yes | The id of the audience |
| `project_id` | string | yes | ID of the project to which the audience belongs |
| `customer_list_id` | string | yes | ID of the customer list backing the audience |
| `name` | string | yes | The name of the audience |
| `rules` | AudienceRules | yes | The audience membership rules. A subscriber matches the audience when any group matches (groups are combined with OR); within a group all conditions must match (conditions are combined with AND). |
| `created_at` | integer | yes | The date the audience was created (ms since epoch) |
| `updated_at` | integer | yes | The date the audience was last updated (ms since epoch) |
| `stats` | AudiencePreviewStats | no |  |
| `customer_sample` | array of AudienceSampleItem | no | Sample of customers matching the audience. Only present when requested with `expand=customer_sample`. |
| `used_by` | AudienceUsedBy | no |  |

<details><summary><code>rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `groups` | array of object | yes | The condition groups, combined with OR. |

<details><summary><code>groups</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conditions` | array of AudienceRuleCondition | yes | The conditions in the group, combined with AND. |

</details>
</details>

<details><summary><code>stats</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `total_customers` | integer | yes |  |
| `active_subscriptions` | integer | yes |  |
| `active_trials` | integer | yes |  |
| `total_revenue` | number | yes | Total revenue in the developer's display currency. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `is_approximate` | boolean | yes | Whether these metrics are approximate. When true, counts and revenue are estimated from a sample rather than exact. |

</details>

<details><summary><code>customer_sample</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_member` |
| `app_user_id` | string | yes |  |
| `app_uuid` | string | yes |  |
| `email` | string | no |  |
| `first_seen_at` | integer | no | Timestamp when the customer was first seen or purchased, in milliseconds since epoch. |
| `last_seen_at` | integer | no | Timestamp when the customer was last seen, in milliseconds since epoch. |
| `status` | string | yes |  |
| `total_spent` | number | yes | Total gross across the subscriber's subscriptions and one-time purchases, in `currency`, or null when no production purchase or exchange rate exists. |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `latest_product_name` | string | no | Display name of the most recent non-sandbox subscription or one-time purchase product, or null if none. |

</details>

<details><summary><code>used_by</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `audience_used_by` |
| `targeting_rules` | array of AudienceTargetingRuleReference | yes | Targeting rules that reference this audience |
| `experiments` | array of AudienceExperimentReference | yes | Experiments that reference this audience |

<details><summary><code>targeting_rules</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `targeting_rule_reference` |
| `id` | string | yes | The id of the targeting rule |
| `display_name` | string | yes | The display name of the targeting rule |
| `state` | string | yes | Whether the targeting rule is currently active One of: `active`, `inactive` |

</details>

<details><summary><code>experiments</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | One of: `experiment_reference` |
| `id` | string | yes | The id of the experiment |
| `display_name` | string | yes | The display name of the experiment |
| `status` | string | yes | The status of the experiment One of: `draft`, `running`, `paused`, `stopped` |

</details>
</details>