# Get time-series metrics for a dynamic set.

`GET /sets/{set_id}/time_series`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-get-set-time-series · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmGetSetTimeSeries` · Tag: Dynamic Sets

Returns daily time-series data for one or more metrics over a date range, aggregated across the active member listings of the set.
**Paid sets only.** Returns `404 Not Found` for a free set — upgrade it first with `POST /sets/{set_id}/upgrade`.

Available metrics: `asking_rate_w_fees`, `occupancy`, `occupancy_adjusted`, `adr_w_fees`, `lead_time`, `revpar_adjusted_w_fees`, `revpar_w_fees`, `revenue_w_fees`, `nights_bookable`.

## Request

`GET https://api.usewheelhouse.com/ss_api/v1/sets/{set_id}/time_series`

Authentication: send your RM API key in the `X-Integration-Api-Key` header (see https://docs.usewheelhouse.com/rm/authentication.md). Read-only keys can call this endpoint.

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `set_id` | integer | yes | The Wheelhouse internal dynamic set ID. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `metric` | array of string | no | Metrics to include. Defaults to all metrics. Send more than one in brackets (`?metric[]=asking_rate_w_fees&metric[]=occupancy`); a key repeated without brackets keeps only its last value. (each item one of: `occupancy`, `occupancy_adjusted`, `nights_bookable`, `asking_rate_w_fees`, `adr_w_fees`, `lead_time`, `revpar_adjusted_w_fees`, `revpar_w_fees`, `revenue_w_fees`) |
| `start_date` | string (date) | no | Start of the date range (YYYY-MM-DD). Defaults to today. Must be within 3 years in the past and 1 year in the future. |
| `end_date` | string (date) | no | End of the date range (YYYY-MM-DD). Defaults to 1 year from today. Must be after `start_date`. |

### Example request

```bash
curl -X GET 'https://api.usewheelhouse.com/ss_api/v1/sets/{set_id}/time_series' \
  -H 'X-Integration-Api-Key: <your RM API key>'
```

Only required parameters and body fields are filled in, with placeholder values. Add the optional ones you need from the lists above; some are required in combination, as their descriptions say.

## Responses

### 200

Time-series data for the dynamic set.

Body (`application/json`): object

- `currency` (string): ISO-4217 currency code for monetary metrics.
- `updated_at` (string, example: `2026-08-30 04:17:22 UTC`): When the underlying set report was last generated, as a timestamp with a time zone abbreviation rather than ISO-8601.
- `data` (array of object): Daily metric values.
  - `stay_date` (string (date)): Stay date (YYYY-MM-DD).
  - `occupancy` (number, nullable): Occupancy rate (0–1). Present when `occupancy` is requested.
  - `occupancy_adjusted` (number, nullable): Occupancy rate over open (non-blocked) nights (0–1). Present when `occupancy_adjusted` is requested.
  - `nights_bookable` (number, nullable): Number of open (non-blocked) available room-nights. Present when `nights_bookable` is requested.
  - `asking_rate_w_fees` (number, nullable): Average asking rate including fees. Present when `asking_rate_w_fees` is requested.
  - `adr_w_fees` (number, nullable): Average daily rate including fees of booked rooms. Present when `adr_w_fees` is requested.
  - `lead_time` (number, nullable): Average lead time in days. Present when `lead_time` is requested.
  - `revpar_adjusted_w_fees` (number, nullable): Revenue per open available room-night including fees. Present when `revpar_adjusted_w_fees` is requested.
  - `revpar_w_fees` (number, nullable): Revenue per available room-night including fees. Present when `revpar_w_fees` is requested.
  - `revenue_w_fees` (number, nullable): Total revenue including fees. Present when `revenue_w_fees` is requested.

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "currency": "string",
  "updated_at": "2026-08-30 04:17:22 UTC",
  "data": [
    {
      "stay_date": "2026-01-01",
      "occupancy": 0,
      "occupancy_adjusted": 0,
      "nights_bookable": 0,
      "asking_rate_w_fees": 0,
      "adr_w_fees": 0,
      "lead_time": 0,
      "revpar_adjusted_w_fees": 0,
      "revpar_w_fees": 0,
      "revenue_w_fees": 0
    }
  ]
}
```

### 204

Not enough data for the requested parameters.

### 400

Invalid parameter value (e.g. invalid date range).

### 401

API key authorization failed.

### 404

Dynamic set not found, not accessible to the user, or not a paid set.

### 429

Rate limit exceeded — the API key has sent too many requests. Wait before retrying. See the **Rate Limits** section in the overview for the recommended exponential backoff strategy.

Body (`application/json`): object

- `error` (string, example: `API token is at rate limit`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "API token is at rate limit"
}
```
