Skip to main content
GET
List content gaps

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

projectId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"b1f2c3d4-0000-4000-8000-000000000000"

Response

Gaps fetched successfully

promptGaps
object[]
required

Prompts where at least half of the engines answering in the last 30 days left out the brand, plus won gaps that have a brief, highest opportunity first. Ignored gaps are excluded.

searchGaps
object[]
required

Pending prompt suggestions from Google Search Console queries. Clicks, impressions and positions are from the Search Console data covering 31 to 3 days before the suggestion was generated, and are not refreshed later.

aiSearchGaps
object[]
required

Web searches AI engines ran in scan answers without mentioning the brand or citing its site.

hasScanData
boolean
required

False until the project has at least one scan result.

snapshotReady
boolean
required

False while the project's content gaps snapshot is being prepared.

organization
object
required