Omnia docs
REST APIViewPerformance

Get metric breakdown

Retrieve one metric over the prompts the view groups as one ranking per prompt or per AI engine. The prompt set comes from the view's saved filters. Each ranking keeps its leading brands (or cited domains) plus the brand itself; prompts and engines with no AI answers in the range are left out.

GET
/api/v1/views/{view}/breakdown

Authorization

BearerAuth
AuthorizationBearer <token>

API token authentication. Use format: Bearer ot_your-token-here

In: header

Path Parameters

view*string

Unique identifier for the view

Formatuuid

Query Parameters

startDate*string

Start date for filtering data (ISO 8601 date format). Range is inclusive.

Formatdate
endDate*string

End date for filtering data (ISO 8601 date format). Range is inclusive.

Formatdate
page?integer

Page number (1-indexed)

Default1
Range1 <= value
pageSize?integer

Number of items per page

Default20
Range1 <= value <= 100
engine?string

Filter by AI engine. If empty, returns results for all engines

Value in"google-ai-overviews" | "google-ai-mode" | "perplexity" | "openai" | "gemini" | "grok" | "copilot" | "claude" | "bing-ai-mode"
metric*string

visibility, share_of_voice, citations (cited domains) or sentiment (relative sentiment)

Value in"visibility" | "share_of_voice" | "citations" | "sentiment"
by*string

prompt returns one ranking per Prompt; engine returns one ranking per AI engine. Prompts and engines with no AI answers in the range are left out.

Value in"prompt" | "engine"
brandName?string

Keep only the brands whose name contains this text, and only the groups where one appears. Not for citations.

sourceName?string

Keep only the domains that contain this text, such as youtube.com, and only the groups where one is cited. Citations only.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.useomnia.com/api/v1/views/550e8400-e29b-41d4-a716-446655440000/breakdown?startDate=2026-01-01&endDate=2026-01-31&metric=visibility&by=prompt"
{
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "totalItems": 420
  },
  "links": {
    "prev": "https://app.useomnia.com/api/v1/resource?page=1&pageSize=10",
    "next": "https://app.useomnia.com/api/v1/resource?page=3&pageSize=10"
  },
  "data": {
    "metric": "visibility",
    "by": "prompt",
    "groups": [
      {
        "promptId": "550e8400-e29b-41d4-a716-446655440000",
        "prompt": "best project management tools",
        "promptType": "Non-Branded",
        "engine": "openai",
        "rows": [
          {
            "brand": "Acme Corporation",
            "domain": "acme.com",
            "relationship": "owned",
            "rank": 3,
            "visibility": 0.25,
            "shareOfVoice": 0.25,
            "mentions": 12,
            "totalCitations": 12,
            "sentiment": 0.4
          }
        ]
      }
    ]
  }
}
{
  "error": {
    "code": 1002,
    "description": "Invalid input parameters"
  }
}
{
  "error": {
    "code": 1004,
    "description": "Invalid or expired API token"
  }
}
{
  "error": {
    "code": 1006,
    "description": "Item not found"
  }
}
{
  "error": {
    "code": 1001,
    "description": "Internal error"
  }
}