---
title: "Partially Update an Analysis"
method: PATCH
path: "/v1/beam/analyses/{analysis_id}"
tags: ["Analyses"]
---

# Partially Update an Analysis

`PATCH /v1/beam/analyses/{analysis_id}`

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.

## Path parameters

- `analysis_id` string, required

## Request body

- PatchAnalysisRequest
  - `name` string — Name of the Analysis.
  - `location` Location — Location of the Analysis. Supports one of the following location options: - `saved_location_id` - `geopoint` with `radius` and `unit`
    - `geopoint` GeoPoint — Contains `lat` and `lon` coordinates for your analysis, e.g. if you are creating an analysis for a store in Seattle you'd specify the latitude and longitude of your store.
      - `lat` string, required — Latitude coordinate as a decimal number between -90 and 90.
      - `lon` string, required — Longitude coordinate as a decimal number between -180 and 180.
    - `radius` number — Must be an integer or a float number up to 2 decimal places. It represents the radius of the event search around your `geopoint` to use for time series modelling and correlation. We **strongly recommend** using the [Suggested Radius API](https://docs.predicthq.com/api/suggested-radius/get-suggested-radius) to find a suitable radius for your location/industry.
    - `unit` 'm' | 'mi' | 'km' | 'ft' — The unit for `radius` where - `m` is meters - `km` is kilometers - `ft` is feet - `mi` is miles
    - `saved_location_id` string — The ID of a previously created Saved Location for your analysis as documented at [Saved Locations API](https://docs.predicthq.com/api/saved-locations/create-a-saved-location)
  - `demand_type` DemandType — Provides information about the demand type of the analysis.
    - `industry` 'accommodation' | 'cpg' | 'tourism' | 'marketing' | 'parking' | 'restaurants' | 'retail' | 'transportation' | 'other' — The industry of the demand data being analysed by Beam. Choosing the right `industry` is important as this will determine the type of features used in the Analysis and will impact the accuracy of the results.
    - `interval` 'day' | 'week'
    - `week_start_day` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
    - `unit_descriptor` string — The description of the unit of demand, which specifies the type or measure being quantified (e.g., "Occupancy Rate", "Sales", "Number of Transactions").
    - `currency_code` 'USD' | 'EUR' | 'GBP' | 'AUD' | 'CAD' — The ISO 4217 standard code representing the currency corresponding to the units of demand.
    - `unit_currency_multiplier` number — The multiplier used to adjust the unit of demand to its equivalent value in the specified currency.
  - `external_id` string — External identifier associated with the Analysis (optional, user-defined).
  - `label` string[] — Comma-separated list of labels that can be used to search and filter analyses.
  - `rank` Rank — Specifies which rank type to use when calculating event impacts and anomaly detection. Optionally, specify the minimum rank level to use when calculating event impacts. **We strongly recommend** not setting the rank levels and instead letting Beam define the best rank levels based on your industry.
    - `type` 'phq' | 'local', required
    - `levels` RankLevels
      - `phq` RankLevel
        - `min` integer, required — Minimum rank value (0-100).
        - `max` integer — Maximum rank value (0-100).
      - `local` RankLevel
        - `min` integer, required — Minimum rank value (0-100).
        - `max` integer — Maximum rank value (0-100).

## Response `204`

Successful Response

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Bearer token scope insufficient
- `404` — Analysis not found
- `409` — Data conflict

---

[API](https://skmtc.net/predicthq/apis/predicthq-events-api.md) · [All operations](https://skmtc.net/predicthq/apis/predicthq-events-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/predicthq/predicthq-events-api/revisions/66cd8ff349dd/schema)