Update GEO analysis by ID

patch

https://api.jasper.ai/v1/geo/analyses/{configId}

label, timezone, schedule and region are free to change and never start a run.

Sending any of competitors, providers, scopes or topicClusters makes it a settings update. Omitted settings fields keep the latest run's values. If the resulting settings are the same as the latest run's, in any order, nothing runs and nothing is charged. Otherwise a new run starts, replacing any run still in progress, and metadata.credits.cost quotes it. Pages never bill on an update; queries bill per provider.

topicClusters replaces the full set. Send the id a previous response returned to keep a cluster or prompt. One without an id keeps the current cluster with the same topic, or prompt with the same text; otherwise it is new and gets a fresh id. Ids are returned in topicClusters.

Updates are idempotent: repeating one that already applied resolves to the same settings, so it starts nothing and charges nothing.

Path Params

configId

string

required

Body Params

competitors

array of objects

length between 1 and 10

competitors

name

string

Display name. Resolved from the website when omitted.

url

uri

required

providers

array of strings

length ≥ 1

AI providers to query.

providers

Allowed:

scopes

array of objects

length between 1 and 10

What the analysis may cover. At least one must be internal, on the same root domain as the current scopes.

scopes

kind

string

enum

required

Allowed:

url

uri

required

match

string

enum

required

How url is matched, as on the analysis settings.scopes. An external scope only accepts page.

Allowed:

topicClusters

array of objects

length between 1 and 10

The full set of topic clusters, replacing the current ones. Keep a cluster or prompt by sending its id. One without an id keeps the current cluster with the same topic, or prompt with the same text; otherwise it is new.

topicClusters

uuid

The id a previous create or update returned for this cluster. When omitted, the current cluster with the same topic is kept, or a new one is created.

topic

string

required

prompts

array of objects

required

length ≤ 10

prompts*

label

string

timezone

string

IANA timezone.

schedule

string

enum

How often the analysis re-runs. one-off requires an entitlement.

Allowed:

region

string | null

enum

Country market provider web searches are localized to. null resets to provider defaults. Setting a region requires the aeo-geo-region entitlement.

200