Analyses

Partially Update an Analysis

Update one or more fields on an existing Analysis without replacing the entire record.

Only the fields you provide will be updated; all other fields remain unchanged.

patch/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/patch.ts
A function with typed inputs. Its response is checked against the schema.

analysis_idstring required

An existing Beam Analysis ID.

namestring

Name of the 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

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