Analysis Groups

Partially Update an Analysis Group

Partially update an existing Analysis Group.

This endpoint accepts the same request body fields as the Create an Analysis Group endpoint.

Remember this is a PATCH endpoint which means only the fields you provide will be updated.

If you wish to replace all fields please use the PUT endpoint.

patch/v1/beam/analysis-groups/{group_id}

Request

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

Path parameters

group_idstring required

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

Request body

namestring

Name of an analysis group.

analysis_idsstring[]

The list of existing analysis IDs to include in the group.

Analyses can belong to multiple groups. Analyses must have the same demand type (the interval must match and, for weekly analyses, week_start_day must also be consistent). Every analysis in the group must have the same industry, if set.

Response

Successful Response

Changes

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