v1

Create a new Rank Radar

Changed on

Creates a new Rank Radar to track keyword rankings for a specific ASIN within a Niche. The Rank Radar will monitor organic and sponsored rankings for the specified number of keywords. Rank Radar Search Term tokens are consumed based on the number of keywords tracked. Returns a rankRadarId for accessing the tracking data.

Warnings. The response carries a warnings array of non-blocking notices about the creation, each with a machine-readable code and a message you can show to a user verbatim. It is empty when there is nothing to flag. Today the only code is FAMILY_ALREADY_TRACKED, returned when one of your existing Rank Radars already tracks an ASIN of the same variation family in the same marketplace — in this Niche or any other. That is allowed: two Rank Radars on one family let you track two different sets of search terms and keep separate statistics. It just costs Tracked Search Terms twice. Treat an unknown code as informational.

Previewing. Send dryRun: true to run every check — validation, quota and the duplicate check — and get the same warnings back without creating anything: no Rank Radar, no Search Term tokens spent, no rows written. rankRadarId is null in that response. dryRun defaults to false, so omitting it behaves exactly as before.

post/v1/niches/rank-radars

Request

  • Base URL
    https://api.datadive.tools
  • URL
    https://api.datadive.tools/v1/niches/rank-radars
  • Auth
    API key in header x-api-key

Request body

asinstring required

The ASIN of the product to track keyword rankings for

numberOfKeywordsnumber required

Number of keywords to track in the Rank Radar. More keywords provide comprehensive tracking but consume more Search Term tokens. Minimum is 1.

nicheIdstring required

The Niche identifier that this Rank Radar is associated with

dryRunboolean

Preview the creation instead of performing it. Runs the same validation, the same quota check and the same duplicate check, and returns the same warnings — but creates no Rank Radar, consumes no Search Term tokens and writes nothing. rankRadarId is null in the response. Defaults to false, so omitting it creates the Rank Radar as before.

Example request

{
  "asin": "B08N5WRWNW",
  "numberOfKeywords": 5,
  "nicheId": "xdGJ6gy7"
}

Response

rankRadarIdstring nullable required

Unique identifier for the created Rank Radar. Use this ID to retrieve keyword ranking data and track performance over time. null when dryRun was set, because nothing was created.

Example response

{
  "rankRadarId": "b3e1f2c4-7e6a-4d2a-9f1e-123456789abc",
  "warnings": [
    {
      "code": "FAMILY_ALREADY_TRACKED",
      "existingRankRadarIds": [
        "b3e1f2c4-7e6a-4d2a-9f1e-123456789abc"
      ]
    }
  ]
}

Changes

    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the success response with the status