PATCH
Update Goal

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Headers

Idempotency-Key
string | null

Any unique string, such as a UUID. Send the same key again to get the first answer and not a second write. The API keeps an answer for 24 hours.

Path Parameters

goal_id
integer
required

A goal of the Business Scorecard of the brand.

brand_id
integer
required

Body

application/json

Only the fields that the request sends change. dimensions: [] removes each dimension.

category
enum<string> | null
Available options:
visibility,
recommendation,
competition,
ranking,
fact_checking,
citations,
sentiment,
ecommerce
dimensions
GoalDimension · object[] | null
Maximum array length: 4
title
string | null
Required string length: 1 - 200

Response

Successful Response

created_at
string<date-time>
required
id
integer
required
runs
GoalRun · object[]
required

The ten newest runs, the newest first.

state
string
required

healthy, partial or needs_attention: if the nightly runs work.

title
string
required
view_type
string
required

The card that draws the goal, such as multi_line.

archived_at
string<date-time> | null
category
string | null
datapoints
Datapoint · object[]

The last 90 days, the oldest first.

dimensions
GoalDimension · object[]
explanation
string[]

How the goal is computed.

intent
string | null

The sentence that the person wrote.

metric
string | null

What the goal measures.

status
string | null

The status of the newest datapoint.

target
string | null

The value that reaches the goal.