Skip to main content
POST
Create Audit query

Authorizations

API-KEY
string
header
required

Headers

Workspace-Id
integer

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

Required range: x >= 1

Body

application/json
keyword
string
required

keyword

Minimum string length: 1
Example:

"How to write content that ranks?"

url
string
required

URL

Pattern: http(s?)://.*
Example:

"https://surferseo.com/"

cache
integer

cache TTL in seconds; if provided, we will try to fetch latest, non-failed query matching the input params before creating a new one

Required range: x >= 900
Example:

3600

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"

Response

Created

id
integer
required

The unique identifier of the entity

Required range: x >= 1
Example:

1

Permalink hash used to share Audit with people

Example:

"G74SCitlYgE_N8iIYIxIS_US8yuUgsfx"

state
enum<string>
required
Available options:
scheduled,
completed,
failed
Example:

"scheduled"