v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB
Analyses

Search Analyses

Returns a paginated list of your Beam Analyses. Supports filtering by status, readiness_status, industry, interval, label, and date range.

get/v1/beam/analyses

Query parameters

statusAnalysisStatus[]

Comma-separated list used to filter Beam analyses by their status.

  • active — returns analyses that are currently in use.
  • deleted — returns analyses that have been deleted.
readiness_statusAnalysisReadinessStatus[]

Comma-separated list used to filter Beam analyses by their readiness status.

  • pending — processing in progress.
  • ready — processing completed successfully.
  • failed — processing failed.
  • stale — results are outdated and need refreshing.
group_idstring[]

An Analysis Group ID. Analyses that belong to this group will be returned.

demand_type.intervalInterval[]

Filter analyses by their demand data interval.

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

Comma-separated list used to filter Beam analyses by industry. Only analyses matching 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
external_idstring[]

Comma-separated list of External IDs.

labelstring[]

Comma-separated list of labels.

location.saved_location_idstring[]

Comma-separated list of Saved Location IDs.

sortAnalysisSortField[]

Comma-separated list used to sort Beam analyses. 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)
limitinteger

Maximum number of results to return per page.

offsetinteger

Zero-based index of the first result to return.

updated.gtstring date

Return analyses last updated after this date (exclusive).

updated.gtestring date

Return analyses last updated on or after this date (inclusive).

updated.ltstring date

Return analyses last updated before this date (exclusive).

updated.ltestring date

Return analyses last updated on or before this date (inclusive).

qstring

Filter analyses by name using a text search. Supports partial and prefix matching (e.g., downt will match Downtown Store).

Response

Successful Response

countinteger required

Total number of analyses matching the query.