v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB

Analysis Groups

Get an Analysis Group

Returns the full details of a single Analysis Group, including its member analyses, demand type, readiness status, and processing state.

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

Path parameters

group_idstring required

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

Response

Successful Response

group_idstring

The autogenerated identifier for the analysis group.

namestring required

Name of the Analysis Group.

analysis_idsstring[]

Comma-separated list of strings containing the IDs of Analyses included in this Group.

user_idstring

The ID of the user who created the Analysis Group. Present for groups created in the WebApp; not populated for groups created via the API.

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

Determines whether the Analysis Group has finished processing. When the group or its analyses are created, modified, or refreshed, readiness_status will be pending until processing completes.

status'active' | 'deleted'

Status of the Analysis Group.

create_dtstring date-time

The creation date time for the Analysis Group in ISO 8601 format.

update_dtstring date-time

The last update date time for the Analysis Group in ISO 8601 format.

processed_dtstring date-time

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