Schedule Ranking Data Export

get

https://api.awrcloud.com/v2/get.php?action=export_ranking

Schedules a ranking data export for one or all projects in your AWR account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

project

string

The name of the project in your account.
If you don't add the parameter, all projects will be included.

startDate

date

required

The oldest date, yyyy-mm-dd format.

stopDate

date

required

The most recent date, yyyy-mm-dd format.

addProjectName

string

enum

Defaults to no

Whether to include the project name for each ranking data.

Allowed:

encodeurl

boolean

Defaults to false

Whether to encode URLs.

format

string

enum

Defaults to csv

Allowed:

searchEngineId

string

Defaults to -1

Use -1 for All Search Engines.

keywordGroupId

string

Defaults to -1

Use -1 for All Keywords, -2 for Branded, -3 for Non Branded.

websiteId

string

Defaults to -1

Use -1 for All Websites.

addSearchIntent

boolean

Defaults to false

Whether to add keyword search intent info.

addTitleLinks

boolean

Defaults to false

Whether to add SERP title links.

addPixelPosition

boolean

Defaults to false

Whether to add pixel position info.

addSerpFeatures

boolean

Defaults to false

Whether to add all found SERP features.

addClickShare

boolean

Defaults to false

Whether to add the Click Share column.

Response

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200