DAdatadive
v1

Add search terms to a Rank Radar

Changed on

Adds manual search terms (keywords) to an existing Rank Radar for tracking. New keywords are added to the Niche and start being tracked, while any previously paused matching keywords are resumed. Daily Tracked Keywords quota is consumed for each newly tracked keyword. Returns the origin breakdown of the submitted terms and keywordToRankRadarKeywordIdMap, mapping each term to its Rank Radar keyword identifier.

post/v1/niches/rank-radars/{rankRadarId}/search-terms

Request

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

Path parameters

rankRadarIdstring required

The unique identifier of the Rank Radar

Request body

AddSearchTermsRequestDto required

Response

originBreakdownobject required
keywordToRankRadarKeywordIdMapobject required

Example response

{
  "originBreakdown": {
    "manual": [
      "puppy",
      "outfits"
    ],
    "suggestions": [
      "dog raincoat"
    ],
    "outliers": [
      "dog swig",
      "dog swim"
    ],
    "residues": [
      "mini cowboy",
      "dog umbrella"
    ],
    "paused": [
      "sunglasses"
    ]
  },
  "keywordToRankRadarKeywordIdMap": {
    "sunglasses": "rank-radar-keyword-id"
  }
}

Changes