List Actions

curl "https://www.qwairy.co/api/v1/brands/{brandId}/actions?status=SUGGESTED&limit=10" \
  -H "Authorization: Bearer qw-api-xxx"

{
  "data": [
    {
      "id": "a1b2c3d4-...",
      "type": "SOURCE_OUTREACH",
      "category": "AUTHORITY",
      "sourceType": "SOURCE_OPPORTUNITY",
      "scope": "OFF_SITE",
      "title": "Get cited by: TechRadar",
      "description": "AI answers cite this source 16 times, but it doesn't mention your brand. Outreach could secure valuable citations.",
      "sourceUrl": "https://techradar.com",
      "targetProvider": null,
      "forceTier": "HIGH",
      "priorityScore": 53,
      "demandBadge": 3,
      "isQuickWin": false,
      "effort": "MEDIUM",
      "status": "SUGGESTED",
      "signals": {
        "citations": 16,
        "sourceCategory": "MEDIA",
        "competitivePressure": 2
      },
      "impactJustification": "Source cited 16x by AI answers without mentioning the brand.",
      "effortJustification": "Outreach: research the contact, pitch, and follow up.",
      "baselineMetric": null,
      "targetMetric": null,
      "questionId": null,
      "checklist": [
        "Review what content the source already cites",
        "Prepare a superior resource or expert angle",
        "Pitch the editorial contact",
        "Track the citation when secured"
      ],
      "createdAt": "2026-06-12T05:00:00.000Z",
      "updatedAt": "2026-06-12T05:00:00.000Z"
    }
  ],
  "pagination": { "total": 42, "limit": 10, "offset": 0, "hasMore": true }
}

GET

api

brands

{brandId}

actions

curl "https://www.qwairy.co/api/v1/brands/{brandId}/actions?status=SUGGESTED&limit=10" \
  -H "Authorization: Bearer qw-api-xxx"

{
  "data": [
    {
      "id": "a1b2c3d4-...",
      "type": "SOURCE_OUTREACH",
      "category": "AUTHORITY",
      "sourceType": "SOURCE_OPPORTUNITY",
      "scope": "OFF_SITE",
      "title": "Get cited by: TechRadar",
      "description": "AI answers cite this source 16 times, but it doesn't mention your brand. Outreach could secure valuable citations.",
      "sourceUrl": "https://techradar.com",
      "targetProvider": null,
      "forceTier": "HIGH",
      "priorityScore": 53,
      "demandBadge": 3,
      "isQuickWin": false,
      "effort": "MEDIUM",
      "status": "SUGGESTED",
      "signals": {
        "citations": 16,
        "sourceCategory": "MEDIA",
        "competitivePressure": 2
      },
      "impactJustification": "Source cited 16x by AI answers without mentioning the brand.",
      "effortJustification": "Outreach: research the contact, pitch, and follow up.",
      "baselineMetric": null,
      "targetMetric": null,
      "questionId": null,
      "checklist": [
        "Review what content the source already cites",
        "Prepare a superior resource or expert angle",
        "Pitch the editorial contact",
        "Track the citation when secured"
      ],
      "createdAt": "2026-06-12T05:00:00.000Z",
      "updatedAt": "2026-06-12T05:00:00.000Z"
    }
  ],
  "pagination": { "total": 42, "limit": 10, "offset": 0, "hasMore": true }
}

Returns the Action Center’s deterministic recommendation queue for a brand: prioritized actions with a 3-tier label, a 0-100 priority score, a 1-5 demand badge, the quantified “why”, the raw signals, and a step-by-step checklist.

Private beta. The Action Center must be enabled for your team; otherwise this endpoint returns 403. Contact your account manager to request access.

string

required

Bearer token. Example: Bearer qw-api-xxx

Path Parameters

string

required

The unique identifier of the brand

Query Parameters

string

Filter by status: SUGGESTED (awaiting triage), PENDING, IN_PROGRESS, COMPLETED, DISMISSED, RESOLVED (signal disappeared, auto-closed). Defaults to the live queue: SUGGESTED + PENDING + IN_PROGRESS.

string

Filter by action type: CONTENT_GAP, CONTENT_OPTIMIZE, TECHNICAL_FIX, SCHEMA_ADD, AUTHORITY_BUILD, SOURCE_OUTREACH, COMPETITOR_ANALYSIS, PERCEPTION_FIX, SEARCH_TARGET, SOCIAL_ENGAGE, PRODUCT_OPTIMIZE, LOCAL_OPTIMIZE

string

Filter by category: TECHNICAL, CONTENT, AEO, AUTHORITY, VISIBILITY

number

default:"50"

Maximum number of actions to return (max: 100)

number

default:"0"

Pagination offset

Response

array

Actions ordered by priority (highest first), then creation date.

Show Action object

string

Unique identifier of the action

string

Action type (see the type filter for values)

string

Action category

string

Detector family that produced the action (e.g. PAGE_ISSUE, QUESTION_GAP, SOURCE_OPPORTUNITY, SEARCH_QUERY)

string

Nature of the work: ON_SITE, OFF_SITE or SETUP

string

Action title

string

What to do and why

string | null

External URL backing the action, when applicable

string | null

AI provider this action is scoped to (null = brand-level)

string

Priority tier: CRITICAL, HIGH or STANDARD

number

Tier-anchored priority score from 0 to 100 (Critical 70-100, High 40-69, Standard below 40), refined by demand, effort and engine scope. Higher means act sooner; it never contradicts the tier.

number

Demand signal from 1 to 5

boolean

High expected impact for low effort

string

Estimated workload: LOW, MEDIUM or HIGH

string

Lifecycle status

object | null

Raw quantified signals behind the priority (citations, fan-out occurrences, impressions, competitive pressure, affected pages…)

string | null

The quantified “why it matters” sentence

string | null

Explanation of the estimated effort

number | null

Metric value when the action was created (outcome measurement)

number | null

Target metric value, when applicable

string | null

Linked monitored prompt, when applicable

array

Step-by-step execution guide

string

ISO 8601 creation date

string

ISO 8601 last update date

object

total, limit, offset, hasMore

curl "https://www.qwairy.co/api/v1/brands/{brandId}/actions?status=SUGGESTED&limit=10" \
  -H "Authorization: Bearer qw-api-xxx"

{
  "data": [
    {
      "id": "a1b2c3d4-...",
      "type": "SOURCE_OUTREACH",
      "category": "AUTHORITY",
      "sourceType": "SOURCE_OPPORTUNITY",
      "scope": "OFF_SITE",
      "title": "Get cited by: TechRadar",
      "description": "AI answers cite this source 16 times, but it doesn't mention your brand. Outreach could secure valuable citations.",
      "sourceUrl": "https://techradar.com",
      "targetProvider": null,
      "forceTier": "HIGH",
      "priorityScore": 53,
      "demandBadge": 3,
      "isQuickWin": false,
      "effort": "MEDIUM",
      "status": "SUGGESTED",
      "signals": {
        "citations": 16,
        "sourceCategory": "MEDIA",
        "competitivePressure": 2
      },
      "impactJustification": "Source cited 16x by AI answers without mentioning the brand.",
      "effortJustification": "Outreach: research the contact, pitch, and follow up.",
      "baselineMetric": null,
      "targetMetric": null,
      "questionId": null,
      "checklist": [
        "Review what content the source already cites",
        "Prepare a superior resource or expert angle",
        "Pitch the editorial contact",
        "Track the citation when secured"
      ],
      "createdAt": "2026-06-12T05:00:00.000Z",
      "updatedAt": "2026-06-12T05:00:00.000Z"
    }
  ],
  "pagination": { "total": 42, "limit": 10, "offset": 0, "hasMore": true }
}

Getting Started

Setup

Cockpit

Monitor

Analyze

Act

Optimize

Agencies

Webhooks

Guides

Path Parameters

Query Parameters

Response

​Path Parameters

​Query Parameters

​Response

Path Parameters

Query Parameters

Response