Feeds

List Campaign Rankings by Date

Arguments

campaign_id required intger (32)

The ID of the campaign to retreive feed for

start_date required date

The start of the range of results to return. Should be a string in the format of YYYY-MM-DD

end_date required date

The end of the range of results to return. Should be a string in the format of YYYY-MM-DD

search string

fuzzy match

page string

The page to return

limit integer (32)

The number of records to return

sort_metric string

The field to sort results by

sort_direction string

The direction of the sort set by sort_metric. May be either asc or dsc.

compare_previous_period string

Enable comparison mode. When set to true, the data returned will represent the net change between the previous and current period. The current period is determined by start_date and end_date.

Endpoint

GET /v3/resources/rankings/campaign/date

Response

json
 {
  "metadata": {
    "total_records": 2,
    "total_pages": 1,
    "version": false
  },
  "data": [
    {
      "date": "2018-01",
      "googleRanking": 10,
      "googleRankingChange": -4,
      "googleRankings_1_3": 2,
      "googleRankings_4_10": 3,
      "googleRankings_11_20": 1,
      "googleRankings_21_50": 3,
      "googleRankings_51": 1,
      "googleMobileRanking": 10,
      "googleMobileRankingChange": -4,
      "googleMobileRankings_1_3": 2,
      "googleMobileRankings_4_10": 3,
      "googleMobileRankings_11_20": 1,
      "googleMobileRankings_21_50": 3,
      "googleMobileRankings_51": 1,
      "googlePlacesRanking": 10,
      "googlePlacesRankingChange": 0,
      "googlePlacesRankings_1_3": 2,
      "googlePlacesRankings_4_10": 3,
      "googlePlacesRankings_11_20": 1,
      "googlePlacesRankings_21_50": 3,
      "googlePlacesRankings_51": 1,
      "bingRanking": 10,
      "bingRankingChange": -5,
      "bingRankings_1_3": 2,
      "bingRankings_4_10": 3,
      "bingRankings_11_20": 1,
      "bingRankings_21_50": 3,
      "bingRankings_51": 1,
      "competitors": 132969000,
      "localMonthlySearches": 69260
    }
  ],
  "totals": {
    "googleRanking": {
      "value": 10
    },
    "googleRankingChange": {
      "value": 10
    },
    "googleMobileRanking": {
      "value": 10
    },
    "googleMobileRankingChange": {
      "value": 3
    },
    "googlePlacesRanking": {
      "value": 10
    },
    "googlePlacesRankingChange": {
      "value": 15
    },
    "bingRanking": {
      "value": 10
    },
    "bingRankingChange": {
      "value": -7
    },
    "competitors": {
      "value": 320001000
    },
    "localMonthlySearches": {
      "value": 90750
    }
  }
}

List Campaign Rankings by Keyword

Arguments

campaign_id required intger (32)

The ID of the campaign to retreive feed for

start_date required date

The start of the range of results to return. Should be a string in the format of YYYY-MM-DD

end_date required date

The end of the range of results to return. Should be a string in the format of YYYY-MM-DD

search string

fuzzy match

page string

The page to return

limit integer (32)

The number of records to return

sort_metric string

The field to sort results by

sort_direction string

The direction of the sort set by sort_metric. May be either asc or dsc.

compare_previous_period string

Enable comparison mode. When set to true, the data returned will represent the net change between the previous and current period. The current period is determined by start_date and end_date.

Endpoint

GET /v3/resources/rankings/campaign

Response

json
 {
  "metadata": {
    "total_records": 10,
    "total_pages": 1,
    "version": false
  },
  "data": [
    {
      "keywordId": 5,
      "keywordPhrase": "tesla used car price",
      "searchLocation": {
        "id": 4,
        "canonical_name": "toronto,ontario,canada",
        "country_code": "ca",
        target_type": "city
      },
      "searchLanguage": {
        "id": 4,
        name": "English
      },
      "primaryKeyword": "",
      "googleRanking": 37,
      "googleRankingChange": -4,
      "googleRankingUrl": "https://www.tesla.com/modelx/",
      "googleSerpUrl": null,
      "googleMobileRanking": 18,
      "googleMobileRankingChange": 7,
      "googleMobileRankingUrl": "https://www.tesla.com/models/",
      "googleMobileSerpUrl": null,
      "googlePlacesRanking": 81,
      "googlePlacesRankingChange": -1,
      "googleMapsSerpUrl": null,
      "bingRanking": 6,
      "bingRankingChange": 15,
      "bingRankingUrl": "https://www.tesla.com/models/",
      "bingSerpUrl": null,
      "localMonthlySearches": 0,
      "competitors": 0,
      "lastGoogleRankingDate": "2019-07-27",
      "lastGoogleMobileRankingDate": "2019-07-27",
      "lastGooglePlacesRankingDate": "2019-07-26",
      "lastBingRankingDate": "2019-07-27",
      "lastSearchVolumeDate": "2019-07-27",
      "lastStatPadderDate": "2019-07-26",
      "lastMetricRollupDate": "2019-07-27",
      "lastResultsDate": "2019-07-26",
      "tags": [
        {
          "id": 2,
          label": "Secondary
        }
      ]
    }
  ]
}

List Keyword Rankings by Date

Arguments

keyword_id required intger (32)

The ID of the keyword to retreive feed for

start_date required date

The start of the range of results to return. Should be a string in the format of YYYY-MM-DD

end_date required date

The end of the range of results to return. Should be a string in the format of YYYY-MM-DD

search string

fuzzy match

page string

The page to return

limit integer (32)

The number of records to return

sort_metric string

The field to sort results by

sort_direction string

The direction of the sort set by sort_metric. May be either asc or dsc.

compare_previous_period string

Enable comparison mode. When set to true, the data returned will represent the net change between the previous and current period. The current period is determined by start_date and end_date.

Endpoint

GET /v3/resources/rankings/keyword/date

Response

json
 {
  "metadata": {
    "total_records": 2,
    "total_pages": 1,
    "version": false
  },
  "data": [
    {
      "date": "2018-01",
      "googleRanking": 86,
      "googleRankingUrl": "https://www.tesla.com/models/",
      "googleMobileRanking": 11,
      "googleMobileRankingUrl": "https://www.tesla.com/powerwall/",
      "googlePlacesRanking": 15,
      "bingRanking": 23,
      "bingRankingUrl": "https://www.tesla.com/models/",
      "competitors": 142409000,
      "localMonthlySearches": 64920
    }
  ],
  "totals": {
    "googleRanking": {
      "value": 30
    },
    "googleMobileRanking": {
      "value": 30
    },
    "googlePlacesRanking": {
      "value": 23
    },
    "bingRanking": {
      "value": 70
    },
    "competitors": {
      "value": 320001000
    },
    "localMonthlySearches": {
      "value": 160010
    }
  }
}