Partially Update an Analysis

Partially update an existing Analysis.

Partially Update an Analysis

patch

Partially update an existing Analysis.

Authorizations

BearerAuth

Path parameters

analysis_idstringRequired

An existing Beam Analysis ID.

Body

application/json

namestring · min: 1Optional

external_idstring · min: 1Optional

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

Example: {"external_id":"abc123"}

labelstring[] · min: 1Optional

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

Invalid request or Saved Location not found

403

Bearer token scope insufficient

404

Analysis not found

409

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

422

Validation Error

application/json

patch

/v1/beam/analyses/{analysis_id}

HTTPcURLJavaScriptPython

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: 340

{
  "name": "text",
  "location": {
    "saved_location_id": "8gZ2rn8BRcTjM_3SWdjP"
  },
  "demand_type": {
    "demand_type": {
      "industry": "restaurants",
      "currency_code": "USD",
      "unit_currency_multiplier": 1,
      "unit_descriptor": "Sales"
    }
  },
  "external_id": {
    "external_id": "abc123"
  },
  "label": [
    "label1",
    "label2",
    "label3"
  ],
  "rank": {
    "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 $ACCESS_TOKEN" \
     --data @<(cat <<EOF
    {
        "name": "Analysis 2",
    }
    EOF
    )  

python

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.

Guides

Below are some guides relevant to this API:

• Beam Guides