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.

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

Defaults to no

Whether to include the project name for each ranking data.

encodeurl

boolean

Defaults to false

Whether to encode URLs.

format

string

Defaults to csv

searchEngineId

int32

Defaults to -1

Use -1 for All Search Engines.

keywordGroupId

int32

Defaults to -1

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

websiteId

int32

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.

Response

Language

Credentials

Query


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.awrcloud.com/v2/get.php?addProjectName=no&encodeurl=false&format=csv&searchEngineId=-1&keywordGroupId=-1&websiteId=-1&addSearchIntent=false&addTitleLinks=false&addPixelPosition=false&addSerpFeatures=false&action=export_ranking' \
3
     --header 'accept: application/json'

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

application/json

200200