Skip to main content
POST
Create a batch of SERP Analyzer queries

Authorizations

API-KEY
string
header
required

Headers

Workspace-Id
integer

Workspace ID to create the queries in. If not provided, uses the oldest active workspace.

Required range: x >= 1

Body

application/json
Minimum array length: 1
keyword
string
required

keyword

Minimum string length: 1
Example:

"How to write content that ranks?"

analyze_nlp_entity_sentiment
boolean
default:false
analyze_nlp_sentiment
boolean
default:false
device
enum<string>
default:mobile
Available options:
mobile,
desktop
location
string
default:United States

Location; get the list of supported locations from /api/v1/locations (no auth required)

Example:

"United States"

screenshot
boolean
default:false

Toggles creating screenshots of pages from the SERP

Example:

Response

Created

id
integer

The unique identifier of the entity

Required range: x >= 1
Example:

1

state
enum<string>
Available options:
scheduled
Example: