v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB
Analysis Groups

Search Analysis Groups

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

get/v1/beam/analysis-groups

Query parameters

updated.gtstring date

Filters analysis groups updated after the specified date (exclusive).

updated.gtestring date

Filters analysis groups updated on or after the specified date.

updated.ltstring date

Filters analysis groups updated before the specified date (exclusive).

updated.ltestring date

Filters analysis groups updated on or before the specified date.

qstring

Query string to be matched against Group name.

statusAnalysisGroupStatus[]

Comma-separated list used to filter analysis groups by their status.

  • active — returns groups that are currently in use.
  • deleted — returns groups that have been deleted.
readiness_statusAnalysisGroupReadinessStatus[]

Comma-separated list used to filter analysis groups by their readiness status.

  • pending — processing in progress.
  • ready — processing completed successfully.
  • failed — processing failed.
demand_type.intervalInterval[]

Filter analysis groups by their demand data interval.

  • day — returns groups with daily demand data.
  • week — returns groups with weekly demand data.
demand_type.industryIndustry[]

Comma-separated list used to filter analysis groups by industry. Only groups whose analyses match one of the specified industries are returned.

  • accommodation — Accommodation providers, travel tech, and OTAs
  • cpg — Consumer packaged goods companies
  • tourism — Leisure, travel, and tourism businesses (e.g. Expedia, DMOs, travel platforms)
  • marketing — Advertising and marketing services
  • parking — Parking facility operators
  • restaurants — Food and beverage businesses including restaurant groups
  • retail — Non-food retail and retail tech
  • transportation — On-demand transport and delivery
  • other — All other industries
sortAnalysisGroupSortField[]

Comma-separated list used to sort Analysis Groups. Prefix a field name with - to reverse the default direction.

  • name: sort alphabetically A–Z
  • -name: sort alphabetically Z–A
  • created: oldest first (ascending)
  • -created: newest first (descending)
  • updated: oldest first (ascending)
  • -updated: newest first (descending)
offsetinteger

Zero-based index of the first result to return.

limitinteger

Maximum number of results to return per page.

Response

Successful Response

countinteger required

Total number of analysis groups matching the query.