Analyses

Create an Analysis

Creating an Analysis is the first step in understanding which types of events impact your demand.

post/v1/beam/analyses

Request

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

namestring required

Name of an analysis.

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.

Successful Response

analysis_idstring

The autogenerated identifier for the analysis.

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