Analyses

Get an Analysis

Returns the full details of a single Analysis, including its location, demand type, rank, readiness status, and processing state.

get/v1/beam/analyses/{analysis_id}

Request

Base URL
https://api.predicthq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/predicthq/apis/predicthq-events-api/docs/v1/beam/analyses/:analysis_id/get.ts
A function with typed inputs. Its response is checked against the schema.

analysis_idstring required

An existing Beam Analysis ID.

Successful Response

namestring required

Name of the Analysis.

user_idstring

Identifier of the user who owns the Analysis.

access_type'full' | 'limited'

status'active' | 'deleted'

readiness_status'pending' | 'failed' | 'ready' | 'stale'

The value of this field determines whether or not the Analysis has successfully completed processing.

When you upload data for an Analysis the readiness_status will be set to pending until processing has completed.

group_idsstring[]

IDs of the groups this Analysis belongs to.

tzstring

The time zone of the Analysis in TZ Database format.

Note: this field is populated automatically based on the location of the Analysis.

create_dtstring date-time

Date and time when the Analysis was created (ISO 8601).

update_dtstring date-time

Date and time when the Analysis was last updated (ISO 8601).

processed_dtstring date-time

Date and time when the Analysis processing completed (ISO 8601).

external_idstring

External identifier associated with the Analysis (optional, user-defined).

labelstring[]

Comma-separated list of labels that can be used to search and filter analyses.

No recorded changes to this operation across all 1 revision of this API.