Partially Update an Analysis

Partially update an existing Analysis.

Partially Update an Analysis

patch

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.

Authorizations

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Path parameters

analysis_idstringRequired

An existing Beam Analysis ID.

Body

namestring · min: 1 · max: 256Optional

Name of the Analysis.

external_idstring · min: 1 · max: 256Optional

External identifier associated with the Analysis (optional, user-defined).

Example: abc123

labelstring[] · min: 1 · max: 100Optional

Comma-separated list of labels that can be used to search and filter analyses.

Example: ["label1","label2","label3"]

Responses

204

Successful Response

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Bearer token scope insufficient

application/json

404

Analysis not found

application/json

409

Data conflict

application/json

patch/v1/beam/analyses/{analysis_id}

PATCH /v1/beam/analyses/{analysis_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "name": "text",
  "location": {
    "saved_location_id": "8gZ2rn8BRcTjM_3SWdjP"
  },
  "demand_type": {
    "industry": "restaurants",
    "currency_code": "USD",
    "unit_currency_multiplier": 1,
    "unit_descriptor": "Sales"
  },
  "external_id": "abc123",
  "label": [
    "label1",
    "label2",
    "label3"
  ],
  "rank": {
    "type": "phq",
    "levels": {
      "phq": {
        "min": 51
      }
    }
  }
}

No content

Examples

curl

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

python

import requests

response = requests.patch(
    url="https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID",
    headers={
        "Authorization": "Bearer $API_TOKEN",
        "Accept": "application/json"
    },
    json={
        "name": "Analysis 2"
    }
)

print(response.status_code)

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.

Guides

Below are some guides relevant to this API:

• Beam Guides