Skip to main content
POST
Keyword-insights search

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
keywords
string[]
required

Keywords to measure conversation volume for.

Required array length: 1 - 100 elements
Minimum string length: 1
granularity
enum<string>
default:DAY
Available options:
DAY,
HOUR
preset
enum<string>

Shortcut for a date range. Default last_7d when no start_date/end_date given.

Available options:
today,
yesterday,
last_7d,
last_14d,
last_30d,
this_month,
last_month
start_date
string

First day, YYYY-MM-DD, in the account's time zone.

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string

Last day (inclusive), YYYY-MM-DD, in the account's time zone. The exclusive end X wants is computed for you.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

200 - application/json

Success