Sign in
v1

Get PPC data for a Rank Radar

Retrieves per-keyword PPC data for the specified Rank Radar within a date range — sponsored rank, impression rank/share, match types hit, impressions, clicks, CTR, CPC, orders, PPC sales, spend, ACOS, and conversion rate. Pass includeCampaigns=true for a per-campaign/ad-group breakdown. Rate limited to approximately 60 requests per minute per API key.

get/v1/niches/rank-radars/{rankRadarId}/ppc

Path parameters

rankRadarIdstring required

The unique identifier of the Rank Radar

Query parameters

startDatestring required
Example:2024-03-01

Start date for the PPC data range in yyyy-mm-dd format. The range can span at most 90 days

endDatestring required
Example:2024-03-26

End date for the PPC data range in yyyy-mm-dd format. The range can span at most 90 days

currentPagenumber
Example:1

The page of keywords to retrieve. By default, it is 1

pageSizenumber
Example:20

Number of keywords per page. By default, it is 20. Max page size is 100

includeCampaignsboolean

Include a per-campaign/ad-group breakdown for each keyword

Response

currentPagenumber required
pageSizenumber required

Number of items per page

hasNextboolean required

True when there is a next page. Otherwise, false

hasPrevboolean required

True when there is a previous page. Otherwise, false

lastPagenumber required

Last page or total page count

totalnumber required

Total number of items

Example response

{
  "currentPage": 1,
  "pageSize": 20,
  "lastPage": 1,
  "total": 1,
  "data": [
    {
      "keyword": "keyword"
    }
  ]
}

Changes

Changed in 2 of the 10 revisions of this API.110

  • 8c35e29328f719See the full diff
    • ▲

      the response's body type changed from array to object for status

      response-body-type-changed

    • ○

      added the new optional query request parameter currentPage

      new-optional-request-parameter

    • ○

      added the new optional query request parameter pageSize

      new-optional-request-parameter

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 179bcdacf4d11See the full diff
    • ○

      endpoint added

      endpoint-added