Partially Update an Analysis Group

Partially update an existing Analysis Group.

Partially Update an Analysis Group

patch

Partially update an existing Analysis Group.

This endpoint accepts the same request body fields as the Create an Analysis 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.

Authorizations

BearerAuth

Path parameters

group_idstringRequired

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

Example: 3ED1zxXqAY

Body

application/json

namestring · min: 1Optional

Name of an analysis group.

Example: My Analysis Group 1

analysis_idsstring[]Optional

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.

Example: ["zRa_kk7MlAA","3aR-gbJp98I","JBb08XsZqAo","q9iX2XqFBxM"]

Responses

202

Successful Response

No content

400

Invalid analysis_ids

403

Bearer token scope insufficient

404

Analysis Group not found

409

A data conflict has occurred due to the analysis group being modified elsewhere. Please retry your call later.

422

Validation Error

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /v1/beam/analysis-groups/{group_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "name": "My Analysis Group 1",
  "analysis_ids": [
    "zRa_kk7MlAA",
    "3aR-gbJp98I",
    "JBb08XsZqAo",
    "q9iX2XqFBxM"
  ],
  "demand_type": {
    "unit_descriptor": "bookings"
  }
}

No content

Examples

curl

curl -X PATCH "https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN" \
     --data @<(cat <<EOF
    {
        "name": "Analysis Group 2",
    }
    EOF
    )  

python

import requests

response = requests.patch(
    url="https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID",
    headers={
        "Authorization": "Bearer $ACCESS_TOKEN",
        "Accept": "application/json"
    },
    json={
        "name": "Analysis Group 2"
    }
)

print(response.status_code)

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.