POST
Upload Search Query Export

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Path Parameters

brand_id
integer
required

Body

multipart/form-data
file
file
required

A CSV or TSV file, up to 15 MB.

source
enum<string> | null

Optional. The tool that wrote the file: google_search_console, bing_webmaster_tools, or other. The detection of the columns does not need it.

Available options:
google_search_console,
bing_webmaster_tools,
other

Response

Successful Response

brand_id
integer
required
column_roles
SearchQueryImportColumn · object[]
required
created_at
string<date-time>
required
file_name
string
required
id
integer
required
row_count
integer
required
status
enum<string>
required
Available options:
embedding,
ready,
failed
rows_in_file
integer | null
source
enum<string> | null

The tool that wrote the uploaded file, when the sender says it.

Jev detects the columns of any file, thus the reader does not need it. The dashboard does not send it, and the API keeps it as an optional label.

Available options:
google_search_console,
bing_webmaster_tools,
other
truncated
boolean
default:false
uploaded_by_user_id
integer | null