API dokumentáció

Programmatikus hozzáférés az AI-láthatósági adataidhoz.

Egy csak olvasható REST API és egy MCP-szerver, mindkettő ugyanazzal a kulccsal hitelesítve. Húzd be a márkákat, lekérdezéseket, futtatásokat, megemlítéseket, napi láthatósági pontszámokat és ajánlásokat a saját dashboardjaidba, warehouse-aidba vagy AI-ügynökeiddé.

Hitelesítés

Bearer tokenek

Generálj API-kulcsot a Beállítások → API-kulcsok menüből az alkalmazásban. A sima szöveges verziót csak a létrehozáskor jeleníti meg – tárold jelszókezelőben. Minden kérésnél Bearer tokenként add meg.

curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands \
  -H "Authorization: Bearer ik_…"

A kulcsok bármikor visszavonhatók ugyanabból a Beállítások panelből. Minden kulcs a fiókodhoz van hatáskörözve és örökli a fiókod márkaengedélyeit – jelenleg nincsenek kulcs-szintű hatáskörök.

Alap URL

Hová mennek a kérések

Az összes REST végpont egyetlen alap URL alatt él:

https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1

Fűzd hozzá az alábbi végpontok elérési útját. GET az egyetlen támogatott metódus – az API csak olvasható.

A márka ID megszerzése

Honnan jön az {id}

A legtöbb végpont elfogad egy {id} elérési út paramétert – ez a márkád UUID-ja. Két módszer a megszerzésére:

  1. Magából az API-ból– hívd meg először a GET /brandsvégpontot. A válaszban minden elemnek van egy idmezője. Ezt az értéket használd a további hívásokban.
  2. A dashboard URL-ből– amikor megnyitsz egy márkát a https://app.intendity.com/brands/<id> helyen, a /brands/ utáni UUID az API-ban használandó márka ID.
Végpontok

Referencia

Hét végpont, mind GET, mind JSON-t ad vissza, mind az API-kulcs tulajdonosára hatáskörözve.

GET /brands

Márkák listázása – ID-k felfedezése

Visszaadja az összes saját márkádat. Hívd meg ezt először, hogy megkapd az `id`-t, amelyet a többi végponton használsz. Ez az egyetlen végpont, amely nem fogad márkaazonosítót elérési út paraméterként.

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "brands": [
    {
      "id": "0ae98f45-446c-4482-886f-9ce2fd6ba4ea",
      "name": "Acme",
      "industry": "B2B SaaS",
      "aliases": ["Acme Corp", "ACME"],
      "competitors": ["Beta", "Gamma"],
      "country": "US",
      "enabled_models": ["openai/gpt-5.2", "anthropic/claude-sonnet-4"],
      "run_frequency": "daily",
      "created_at": "2026-04-01T12:00:00Z"
    }
  ]
}
GET /brands/{id}

Egy márka lekérése

Egyetlen márka id alapján. Ugyanolyan alakú, mint a `/brands` gyűjtemény elemei.

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/0ae98f45-446c-4482-886f-9ce2fd6ba4ea \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "brand": {
    "id": "0ae98f45-446c-4482-886f-9ce2fd6ba4ea",
    "name": "Acme",
    ...
  }
}
GET /brands/{id}/queries

Egy márka lekérdezéseinek listázása

Minden prompt, amelyet ehhez a márkához hozzáadtál. Legújabbtól rendezve.

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/queries?limit=100 \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "queries": [
    {
      "id": "…",
      "text": "best CRM for small B2B teams",
      "tags": ["evaluation"],
      "country": "US",
      "enabled": true,
      "last_run_at": "2026-04-30T04:00:00Z",
      "created_at": "2026-04-01T12:00:00Z"
    }
  ]
}
GET /brands/{id}/runs

Egy márka futtatásainak listázása

Egy sor (lekérdezés × modell) végrehajtásonként. Tartalmazza a modelltől kapott nyers `response` blobot.

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/runs?limit=100 \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "runs": [
    {
      "id": "…",
      "query_id": "…",
      "model": "openai/gpt-5.2",
      "status": "completed",
      "response": "Acme is one of the leading…",
      "error": null,
      "created_at": "2026-04-30T04:01:23Z"
    }
  ]
}
GET /brands/{id}/mentions

Egy márka megemlítéseinek listázása

Futtatásonkénti elemzés: megemlítve volt-e a márka, hol rangsorolt, hangulat, mely versenytársakat nevezték meg, és a modell által hivatkozott forrás URL-ek.

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/mentions?limit=100 \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "mentions": [
    {
      "id": "…",
      "run_id": "…",
      "mentioned": true,
      "position": 3,
      "sentiment": "positive",
      "sentiment_score": 78,
      "context": "Acme stands out for its…",
      "competitors_found": ["Beta"],
      "sources": ["https://en.wikipedia.org/wiki/…"],
      "confidence": 0.92,
      "created_at": "2026-04-30T04:01:24Z"
    }
  ]
}
GET /brands/{id}/visibility

Napi láthatósági pontszámok

Egy sor naponként. A `score` egy 0-100%-os megemlítési arány az adott napon futtatott összes lekérdezés × modell alapján.

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/visibility \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "visibility": [
    {
      "day": "2026-04-30",
      "score": 64,
      "total_runs": 48,
      "total_mentions": 31
    }
  ]
}
GET /brands/{id}/recommendations

Egy márka ajánlásainak listázása

AI-generált következő lépések a láthatóság javítására, munkafolyamat-állapottal (pending → in_progress → done / dismissed).

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/recommendations \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "recommendations": [
    {
      "id": "…",
      "category": "wikipedia",
      "title": "Edit the 'CRM software' Wikipedia article",
      "body": "Three of four models cited Wikipedia…",
      "related_queries": ["…"],
      "status": "pending",
      "due_date": null,
      "completed_at": null,
      "created_at": "2026-04-30T04:05:00Z"
    }
  ]
}
GET /brands/{id}/suggested-prompts

Javasolt promptok

Promptok, amelyeket a rendszer szerint nyomon kellene követned, de még nem adtál hozzá. Az `added: true` azt jelenti, hogy a felhasználó elfogadta a javaslatot (és a prompt most a `/brands/{id}/queries` helyen van).

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/suggested-prompts \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "suggested_prompts": [
    {
      "id": "…",
      "text": "best CRM for small SaaS teams",
      "rationale": "competitor-comparison gap - competitors win 4/5 runs",
      "added": false,
      "created_at": "2026-05-01T04:00:00Z"
    }
  ]
}
GET /brands/{id}/competitor-sov

Versenytársi share of voice

Napi megemlítési számok (versenytárs, modell) szerint. Maga a márka a `__brand__` sentinel alatt van jelentve, tehát a share of voice `brand_count / SUM(count)` a (modell, nap) csoportokon belül. Az időtartomány szűrhető a `?since=YYYY-MM-DD` paraméterrel (alapértelmezés: utolsó 90 nap).

Kérés
curl "https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/competitor-sov?since=2026-04-01" \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "sov": [
    { "competitor": "__brand__", "model": "openai/gpt-5.2", "day": "2026-05-04", "mention_count": 4, "avg_position": 2.5 },
    { "competitor": "Beta",      "model": "openai/gpt-5.2", "day": "2026-05-04", "mention_count": 7, "avg_position": null }
  ]
}
GET /brands/{id}/page-audits

Oldal-auditák – lista

AI-felkészültségi auditák a márka oldalain. Minden sor tartalmazza a pontszámot (0-100), a problémalistát és az elemzett jelzéseket (schema.org típusok, llms.txt jelenlét, AI-bot robots szabályok stb.).

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/page-audits \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "page_audits": [
    {
      "id": "…",
      "url": "https://acme.com/pricing",
      "fetched_at": "2026-05-04T10:12:00Z",
      "status_code": 200,
      "score": 72,
      "issues": [
        { "id": "no-faq-schema", "severity": "warning", "title": "No FAQPage schema", "fix": "Add JSON-LD FAQPage with the top buyer questions.", "score_impact": 8 }
      ],
      "signals": {
        "word_count": 824,
        "h1_count": 1,
        "has_canonical": true,
        "has_meta_description": true,
        "has_faq_schema": false,
        "schema_types": ["Organization", "WebSite"],
        "llms_txt_present": false,
        "robots_blocks_ai": [],
        "ai_bots_allowed": ["GPTBot", "ClaudeBot"]
      },
      "error": null
    }
  ]
}
GET /brands/{id}/page-audits/{auditId}

Oldal-audit – egyedi

Egyetlen audit id alapján. Ugyanolyan alakú, mint a `/brands/{id}/page-audits` gyűjtemény elemei.

Kérés
curl https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/api-v1/brands/{id}/page-audits/{auditId} \
  -H "Authorization: Bearer ik_…"
Válasz (200 OK)
{
  "page_audit": {
    "id": "…",
    "url": "https://acme.com/pricing",
    "score": 72,
    ...
  }
}

Lapozás

Add meg a ?limit=N paramétert a gyűjtemény-végpontokon. Az alapértelmezés 100, maximum 500. A kurzoros lapozás roadmapen van az egy oldalt meghaladó gyűjteményeknél.

Hibák

Állapotkódok

Állapot Mikor
200 Sikeres.
401 Hiányzó vagy érvénytelen Bearer token.
404 A márka vagy az elérési út nem létezik (vagy nem a tied).
405 GET-en kívüli metódus használata.
500 Váratlan szerver hiba – próbáld újra backoff-fal.

A hibaválasz-törzsek tartalmaznak egy error karakterláncot és néha egy hint.

MCP szerver

Használd az Intendity-t Claude-ból / Cursorból / bármely MCP kliensből

Ugyanaz az API-kulcs hitelesíti az MCP-kompatibilis végpontot. Irányíts bármely Model Context Protocol klienst erre a végpontra, és a márka-láthatósági adataid eszközként elérhetők az asszisztensbenn.

https://ipxntaczzxemkezuofzl.supabase.co/functions/v1/mcp

Hitelesítés: Authorization: Bearer ik_… az SSE / HTTP transzporton. Nézd meg az MCP-kliensed dokumentációját, hogyan regisztrálj egyéni szervert fejléccel.

Olyan végpontra van szükséged, amely hiányzik?

Írási képességek, webhookök, kurzoros lapozás – mind a roadmapen vannak. Mondd el, mit építenél, és prioritizálunk ennek megfelelően.

[email protected]