Get the overview

GET

/overview

Everything on the app’s Home page for a period: visibility, share of voice, position and citations against the top rivals (overall and per day), brand perception, cited pages, topics weakest first, AI traffic, the AI readiness score and open tasks per layer.

Authorizations

• apiKey

Parameters

Query Parameters

brand_id

integer

The brand to read, from GET /brands. Required when the account has more than one brand.

market

string

The market to read, from GET /markets: its code (IN-hi, or just IN) or id. Default: the primary market.

Example

IN-hi

days

integer

>= 1 <= 90

How many days back, ending today. Default 7. Ignored when from is given.

from

string format: date

Start date (YYYY-MM-DD). At most 90 days before to.

to

string format: date

End date (YYYY-MM-DD). Default today.

Responses

200

OK

object

data

required

object

meta

required

object

api_version

string

Example

v1

brand

object

id

integer

name

string

market

object

id

integer

code

string

label

string

400

Invalid parameter, or brand_id missing on a multi-brand account (brand_required).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

401

Missing, revoked or unknown API key (invalid_api_key).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

403

The plan doesn’t include this data (feature_not_in_plan) or the plan isn’t active (plan_inactive).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

404

The brand or the requested item doesn’t exist (brand_not_found, not_found).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

409

The integration this needs isn’t connected (integration_not_connected).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

429

Monthly read limit reached (quota_exceeded) or more than 60 requests a minute (rate_limited).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

502

An upstream service failed; retry later (upstream_error).

object

error

required

object

code

required

string

Example

brand_required

message

required

string