PATCH
Update Tracked Url

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

tracked_url_id
integer
required

A tracked URL of the brand.

brand_id
integer
required

Body

application/json

Only the fields that the request sends change. group_id: null takes the page out of its group.

group_id
integer | null
title
string | null
Required string length: 1 - 500
url
string | null
Required string length: 1 - 2048

Response

Successful Response

citation_rate
number
required

From 0 to 1: citations divided by conversations.

Example:

0.04

citations
integer
required

The answers of the range that cite the page.

conversations
integer
required

The answers of the range that the count reads.

created_at
string<date-time>
required
id
integer
required
title
string
required
url
string
required

The address, in its normal form.

first_cited
string<date-time> | null

The first answer of the range that cites the page.

group
TrackedUrlGroupRef · object | null