v1

Get Niche Dive status

Retrieves the current status of a Niche Dive analysis. Returns different response schemas based on the Dive state: in_progress (with estimated completion time), success (with nicheId and token usage), or error (with error details). Poll this endpoint to track the progress of a Dive until completion.

get/v1/niches/dives/{diveId}

Request

  • Base URL
    https://api.datadive.tools
  • URL
    https://api.datadive.tools/v1/niches/dives/{diveId}
  • Auth
    API key in header x-api-key

Path parameters

diveIdstring required

The unique identifier of the Dive

Response

OR
OR

Example response

{
  "diveId": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "in_progress",
  "nicheId": "HdNCcryRCs",
  "tokensUsed": 30,
  "tokensLeft": 1000
}

Changes

No recorded changes to this operation across all 19 revisions of this API.