---
title: "Search Analysis Groups"
method: GET
path: "/v1/beam/analysis-groups"
tags: ["Analysis Groups"]
---

# Search Analysis Groups

`GET /v1/beam/analysis-groups`

Returns a paginated list of your Analysis Groups. Supports filtering by `status`, `readiness_status`,
`industry`, `interval`, and date range.

## Query parameters

- `updated.gt` string, date
- `updated.gte` string, date
- `updated.lt` string, date
- `updated.lte` string, date
- `q` string
- `status` AnalysisGroupStatus[]
- `readiness_status` AnalysisGroupReadinessStatus[]
- `demand_type.interval` Interval[]
- `demand_type.industry` Industry[]
- `sort` AnalysisGroupSortField[]
- `offset` integer
- `limit` integer

## Response `200`

Successful Response

- MultiAnalysisGroupResponse
  - `count` integer, required — Total number of analysis groups matching the query.
  - `groups` AnalysisGroupResponse[], required — The list of analysis groups in the current page.
    - `group_id` string — The autogenerated identifier for the analysis group.
    - `name` string, required — Name of the Analysis Group.
    - `analysis_ids` string[] — Comma-separated list of strings containing the IDs of Analyses included in this Group.
    - `user_id` string — The ID of the user who created the Analysis Group. Present for groups created in the WebApp; not populated for groups created via the API.
    - `processing_completed` AnalysisGroupProcessingCompleted — Determines whether the aggregated Feature Importance is ready to be viewed for this Analysis Group and may include a list of excluded analyses with reasons.
      - `feature_importance` boolean — Indicates whether the aggregated Feature Importance is ready to be viewed for this Analysis Group.
      - `value_quant` boolean — Indicates whether the Value Quant is ready to be viewed for this Analysis Group.
      - `excluded_analyses` ExcludedAnalysis[] — A list of Analyses that were excluded from processing, with reasons.
        - `analysis_id` string, required — The ID of the excluded analysis.
        - `reason` 'analysis_not_found' | 'analysis_deleted' | 'analysis_failed' | 'analysis_not_ready' | 'analysis_demand_type_inconsistent' | 'analysis_feature_importance_incomplete' | 'analysis_value_quant_incomplete', required
        - `excluded_from` ExcludedFromReason[] — The processing stages from which this analysis was excluded.
    - `readiness_status` 'pending' | 'failed' | 'ready' — Determines whether the Analysis Group has finished processing. When the group or its analyses are created, modified, or refreshed, `readiness_status` will be `pending` until processing completes.
    - `demand_type` DemandTypeResponse — Indicates the detected type of the uploaded demand data as well as other user-defined information about the demand data.
      - `industry` 'accommodation' | 'cpg' | 'tourism' | 'marketing' | 'parking' | 'restaurants' | 'retail' | 'transportation' | 'other' — The industry of the demand data being analysed by Beam. Choosing the right `industry` is important as this will determine the type of features used in the Analysis and will impact the accuracy of the results.
      - `interval` 'day' | 'week'
      - `week_start_day` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
      - `unit_descriptor` string — The description of the unit of demand, which specifies the type or measure being quantified (e.g., "Occupancy Rate", "Sales", "Number of Transactions").
      - `currency_code` 'USD' | 'EUR' | 'GBP' | 'AUD' | 'CAD' — The ISO 4217 standard code representing the currency corresponding to the units of demand.
      - `unit_currency_multiplier` number — The multiplier used to adjust the unit of demand to its equivalent value in the specified currency.
    - `status` 'active' | 'deleted' — Status of the Analysis Group.
    - `create_dt` string, date-time — The creation date time for the Analysis Group in ISO 8601 format.
    - `update_dt` string, date-time — The last update date time for the Analysis Group in ISO 8601 format.
    - `processed_dt` string, date-time — Date and time when the Analysis Group processing completed (ISO 8601).

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Bearer token scope insufficient

---

[API](https://skmtc.net/predicthq/apis/predicthq-events-api.md) · [All operations](https://skmtc.net/predicthq/apis/predicthq-events-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/predicthq/predicthq-events-api/revisions/66cd8ff349dd/schema)