Schedule Top Sites Export

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

Schedules a top sites export for a single project.

Query Params

project

string

required

Defaults to My Project

The name of the project in your account.

startDate

date

required

The oldest date, yyyy-mm-dd format.

stopDate

date

required

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

encodeurl

boolean

Defaults to false

Whether to encode URLs.

topUrls

int32

Defaults to 200

How many URLs to export for each page.

searchEngine

json

JSON array with one or multiple search Engine IDs: [1, 2, 3]. Leave it out to get data for all search engines.

keywordGroupId

json

Alternative to keywordGroupName. JSON array with one or multiple keyword group IDs: [1, 2, 3]. Leave it out to get data for All Keywords.

keywordGroupName

json

Alternative to keywordGroupId. JSON array with one or multiple keyword group names: ["keyword group 1", "keyword group 2", "keyword group 3"]. Leave it out to get data for All Search Engines.

sponsored

boolean

Defaults to true

Whether to include sponsored results in your export.

resultType

json

JSON array with one or more result types to include. If set, your export will only include these types. Possible values: featured snippets (includes all subtypes: paragraph, list, table, video), featured snippets paragraph, featured snippets list, featured snippets table, featured snippets video, sitelinks, top stories, images, knowledge panel, videos, tweets, local pack, people also ask, carousel, direct answer, recipes, sponsored (can only be added if the sponsored parameter is not set to false), reviews, faq. Example: ["featured snippets paragraph", "featured snippets list"].

pixelPosition

boolean

Defaults to false

Whether to include the Pixel Position column in your export.

xlsx

boolean

Defaults to false

Whether to export an XLSX instead of a CSV.

Response

Language

Credentials

Query


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.awrcloud.com/v2/get.php?project=My%20Project&encodeurl=false&topUrls=200&sponsored=true&pixelPosition=false&xlsx=false&action=topsites_export' \
3
     --header 'accept: application/json'

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

application/json

200200