Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cognerd.in/llms.txt

Use this file to discover all available pages before exploring further.

The analyses endpoints let you retrieve and manage the brand analyses stored in your CogNerd account. Use these endpoints to fetch historical results for your dashboard, build integrations that display visibility trends, or clean up analyses you no longer need. All endpoints require authentication and return standard JSON responses.

List all analyses

Retrieves all past brand analyses for your authenticated account, ordered by most recent first.

Endpoint

GET https://api.cognerd.in/api/brand-monitor/analyses

Request headers

Authorization
string
required
Your API token in the format Bearer YOUR_TOKEN.

Response

analyses
array
Array of analysis summary objects.

Code examples

curl --request GET \
  --url https://api.cognerd.in/api/brand-monitor/analyses \
  --header 'Authorization: Bearer YOUR_TOKEN'

Example response

{
  "analyses": [
    {
      "id": "ana_01j9z4k8m3f7c2x1v5b9n6p0q",
      "brandName": "Acme Corp",
      "brandUrl": "https://acmecorp.com",
      "createdAt": "2026-04-27T10:01:10.000Z",
      "visibilityScore": 67,
      "status": "completed"
    },
    {
      "id": "ana_01j9y2h5k8d4b3w7r1m9n4p2t",
      "brandName": "Acme Corp",
      "brandUrl": "https://acmecorp.com",
      "createdAt": "2026-04-20T09:15:42.000Z",
      "visibilityScore": 61,
      "status": "completed"
    }
  ]
}

Get a single analysis

Retrieves the full analysis result for a specific analysis ID, including all visibility metrics, competitor data, platform breakdown, alerts, sources, and prompt analytics.

Endpoint

GET https://api.cognerd.in/api/brand-monitor/analyses/:id

Path parameters

id
string
required
The unique identifier of the analysis to retrieve. Obtain this from the list analyses endpoint or from a previous POST /analyze result.

Request headers

Authorization
string
required
Your API token in the format Bearer YOUR_TOKEN.

Response

The response contains the full analysis result object. The structure matches the data payload emitted in the final result SSE event from the POST /analyze endpoint.
id
string
Unique analysis identifier.
brandName
string
The brand name analyzed.
brandUrl
string
The brand URL analyzed, if provided.
createdAt
string
ISO 8601 timestamp of when the analysis was created.
overview
object
High-level mention and score summary.
visibility
object
Visibility metrics broken down by platform and time.
competitors
object
Competitor ranking data.
alerts
object
Auto-generated alerts from this analysis run.
sources
object
Source attribution mapping AI citations to specific pages.
prompts
object
Per-prompt analytics.
interruptedRun
boolean
true if this analysis was interrupted before it completed. Partial results may be present.

Code examples

curl --request GET \
  --url https://api.cognerd.in/api/brand-monitor/analyses/ana_01j9z4k8m3f7c2x1v5b9n6p0q \
  --header 'Authorization: Bearer YOUR_TOKEN'

Example response

{
  "id": "ana_01j9z4k8m3f7c2x1v5b9n6p0q",
  "brandName": "Acme Corp",
  "brandUrl": "https://acmecorp.com",
  "createdAt": "2026-04-27T10:01:10.000Z",
  "overview": {
    "mentions": { "total": 12, "explicit": 9, "implicit": 3 },
    "citations": { "total": 5 },
    "scores": { "visibilityScore": 67, "averagePosition": 2.3 },
    "opportunities": 4
  },
  "visibility": {
    "score": 67,
    "dailyTrend": [
      { "date": "2026-04-27", "score": 67 }
    ],
    "platformBreakdown": [
      {
        "platform": "ChatGPT",
        "score": 72,
        "mentions": 5,
        "citations": 3,
        "sentiment": "positive",
        "change": 4
      },
      {
        "platform": "Gemini",
        "score": 61,
        "mentions": 4,
        "citations": 2,
        "sentiment": "neutral",
        "change": -1
      }
    ]
  },
  "competitors": {
    "competitors": [
      {
        "name": "Acme Corp",
        "visibility": 67,
        "mentions": 12,
        "shareOfVoice": 38,
        "avgPos": 2.3,
        "isOwn": true
      },
      {
        "name": "Rival Co",
        "visibility": 74,
        "mentions": 15,
        "shareOfVoice": 47,
        "avgPos": 1.8,
        "isOwn": false
      }
    ]
  },
  "alerts": {
    "alerts": [
      {
        "id": "alert-1",
        "type": "visibility_spike",
        "title": "Visibility spike on ChatGPT",
        "description": "Your visibility on ChatGPT increased by 4 points since the last analysis.",
        "time": "just now"
      }
    ]
  },
  "sources": {
    "sources": [
      {
        "domain": "acmecorp.com",
        "urls": ["https://acmecorp.com/features", "https://acmecorp.com/pricing"],
        "mentions": 8,
        "citations": 3
      }
    ]
  },
  "prompts": {
    "prompts": [
      {
        "prompt": "What are the best project management tools for remote teams?",
        "visibility": 72,
        "avgPosition": 2,
        "trending": true
      }
    ]
  },
  "interruptedRun": false
}

Error responses

StatusMeaning
401Missing or invalid Authorization header.
404No analysis with the given ID exists, or it belongs to a different account.

Delete an analysis

Permanently deletes an analysis from your account. This action cannot be undone.

Endpoint

DELETE https://api.cognerd.in/api/brand-monitor/analyses/:id

Path parameters

id
string
required
The unique identifier of the analysis to delete.

Request headers

Authorization
string
required
Your API token in the format Bearer YOUR_TOKEN.

Response

success
boolean
true when the analysis was successfully deleted.
id
string
The ID of the deleted analysis.

Code examples

curl --request DELETE \
  --url https://api.cognerd.in/api/brand-monitor/analyses/ana_01j9z4k8m3f7c2x1v5b9n6p0q \
  --header 'Authorization: Bearer YOUR_TOKEN'

Example response

{
  "success": true,
  "id": "ana_01j9z4k8m3f7c2x1v5b9n6p0q"
}

Error responses

StatusMeaning
401Missing or invalid Authorization header.
404No analysis with the given ID exists, or it belongs to a different account.