Dorqa API

Three calls to your first result

1. Create a key in the app, under AI assistants and API. Copy it when it appears. It is shown once.

2. Check it works. This call is free and returns your plan and today’s units.

curl https://api.dorqa.io/v1/usage \
  -H "Authorization: Bearer YOUR_KEY"

3. List your projects, then ask for one project’s Brief by its domain.

curl https://api.dorqa.io/v1/projects \
  -H "Authorization: Bearer YOUR_KEY"

curl "https://api.dorqa.io/v1/projects/example.com/brief?sections=search_console" \
  -H "Authorization: Bearer YOUR_KEY"

One key per workspace, sent as a header

Send the key in the Authorization: Bearer dq_live_... header. x-api-key: dq_live_... is also accepted.

Keys belong to the workspace, not to a person. Everyone in the workspace sees the same keys, and a key keeps working when the person who made it leaves. The owner, or the person who made a key, can rotate or revoke it at any time. Rotating gives a new secret and stops the old one straight away.

Dorqa stores keys only as hashes, so a lost key cannot be recovered. Create a new one instead.

Every call runs with the access the workspace already has in the app: the same projects, the same data. The API cannot change anything.

A stated daily allowance, not a surprise bill

Each call costs a number of units, shown on every endpoint below. Units are counted per workspace per UTC day and reset at 00:00 UTC. A key can also carry its own daily limit, so one runaway script cannot use up the whole workspace’s allowance. Requests are also limited per minute, counted across all of the workspace’s keys, so a burst is slowed down rather than spending the day’s units in seconds.

Calls that fail on our side (a 5xx response) are not counted. API units are separate from the credits you spend in the app. See pricing for plans.

Every response carries these headers:

Five endpoints in version one

Base address: https://api.dorqa.io/v1. Every endpoint is a GET.

curl https://api.dorqa.io/v1/usage -H "Authorization: Bearer YOUR_KEY"

{
  "data": {
    "plan": "pro",
    "daily_units": 5000,
    "units_used_today": 6,
    "units_remaining_today": 4994,
    "resets_at": "2026-09-26T00:00:00+00:00",
    "row_cap": 50,
    "endpoint_units": { "usage": 0, "projects": 1, "brief": 5, "internal_links": 1, "questions": 1 }
  },
  "meta": { "endpoint": "usage", "units_charged": 0, "units_used_today": 6, "api_version": "2026-09-25" }
}

curl https://api.dorqa.io/v1/projects -H "Authorization: Bearer YOUR_KEY"

{
  "data": {
    "projects": [
      { "domain": "example.com", "name": "example.com", "search_console": true, "analytics": true }
    ],
    "count": 1,
    "note": "Refer to a project by its domain in other endpoints."
  },
  "meta": { "endpoint": "projects", "units_charged": 1, "units_used_today": 1, "api_version": "2026-09-25" }
}

curl "https://api.dorqa.io/v1/projects/example.com/brief?sections=search_console" \
  -H "Authorization: Bearer YOUR_KEY"

{
  "data": {
    "project": { "domain": "example.com", "name": "example.com" },
    "generated_at": "2026-09-25T07:58:03.317Z",
    "window": {
      "current":  { "start": "2026-08-26", "end": "2026-09-22" },
      "previous": { "start": "2026-07-29", "end": "2026-08-25" },
      "data_through": "2026-09-22",
      "days": 28
    },
    "sections": {
      "search_console": {
        "status": "ok",
        "headline": {
          "source": "Google Search Console",
          "clicks": { "value": 47, "change_pct": 30.6 },
          "impressions": { "value": 10509, "change_pct": -16.8 }
        }
      }
    }
  },
  "meta": { "endpoint": "brief", "units_charged": 5, "cache": "hit", "api_version": "2026-09-25" }
}

curl "https://api.dorqa.io/v1/projects/example.com/internal-links?limit=10" \
  -H "Authorization: Bearer YOUR_KEY"

{
  "data": {
    "project": { "domain": "example.com" },
    "suggestions": [
      {
        "page_to_edit": { "url": "https://example.com/guide/", "title": "The guide" },
        "link_text": "keyword research",
        "link_to": { "url": "https://example.com/keyword-research/", "title": "Keyword research" },
        "score": 82,
        "why": "the link text is a search the target page already appears for"
      }
    ],
    "source": "Dorqa site scan"
  }
}

curl "https://api.dorqa.io/v1/questions?topic=seo+course&market=IN" \
  -H "Authorization: Bearer YOUR_KEY"

{
  "data": {
    "topic": "seo course",
    "questions": [
      { "question": "which seo course is best", "market": "India",
        "monthly_searches": 1300, "volume_source": "keyword_research", "seen_on": ["paa"] }
    ],
    "note": "monthly_searches is null when no volume was measured."
  }
}

One shape for success, one for failure

A successful call returns { "data": ..., "meta": ... }. A failed call returns an HTTP status and { "error": { "code", "message" } }.

What the numbers mean

The API follows the same rules as every screen in Dorqa. Read them in full on data quality.

Stored data only. Version 1 reads data Dorqa already holds. No call starts a crawl or a paid lookup.

Every figure is sourced and dated. Brief sections state their source and window, or why they are not available.

Null means not measured, never zero. A missing figure is null, and a section that could not be built says so with a reason.

The Brief is rebuilt at most every six hours. generated_at in each response says when it was built. Search Console data lags two to three days, which the window’s data_through states.

Before you build