Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tryprofound.com/llms.txt

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

This guide provides practical examples of common API requests. All examples use JSON format and require authentication via API key.
Replace your_api_key, your_category_id, and your_company_name with your actual values. Category IDs can be obtained from /v1/org/categories.
All examples use simplified date formats. For production use, please read Date Ranges & Timezones to understand timezone handling and avoid common pitfalls with date parameters.

​
Visibility Reports

Retrieve visibility metrics and performance data for companies within specific categories. See the full endpoint reference for all available metrics, dimensions, and filters.
Visibility Score

​
Sentiment Analysis

Analyze sentiment data and emotional responses across companies and topics. See the full endpoint reference for all available metrics, dimensions, and filters.
The same filter composition shown in Mixed AND/OR Tag Filtering works on this endpoint.
Sentiment AnalysisIdentify companies with the most positive sentiment:
POST /v1/reports/sentiment HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["positive"],
  "dimensions": ["asset_name"],
  "pagination": { "limit": 5 }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [2413], "dimensions": ["Company A"] },
    { "metrics": [1856], "dimensions": ["Company B"] },
    { "metrics": [1204], "dimensions": ["Company C"] },
    { "metrics": [987], "dimensions": ["Company D"] },
    { "metrics": [714], "dimensions": ["Company E"] }
  ]
}
Sentiment metrics are integer counts, not percentages like visibility. positive = count of positive sentiment instances for that asset.Available sentiment metrics: positive, negative, occurrences (total count).
Use case: Understand which companies have the best reputation and sentiment.

​
Citation Reports

Track mentions, references, and citation patterns across domains and pages. See the full endpoint reference for all available metrics, dimensions, and filters.
The same filter composition shown in Mixed AND/OR Tag Filtering works on this endpoint.
Citation Share
Track citation share by domain with daily granularity:
POST /v1/reports/citations HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-04-08",
  "end_date": "2026-04-15",
  "metrics": ["citation_share"],
  "dimensions": ["date", "hostname"],
  "date_interval": "day",
  "order_by": { "date": "asc" }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.092], "dimensions": ["2026-04-08 00:00:00", "example-a.com"] },
    { "metrics": [0.028], "dimensions": ["2026-04-08 00:00:00", "example-b.com"] },
    { "metrics": [0.021], "dimensions": ["2026-04-08 00:00:00", "example-c.com"] },
    { "metrics": [0.018], "dimensions": ["2026-04-08 00:00:00", "example-d.com"] },
    { "metrics": [0.015], "dimensions": ["2026-04-08 00:00:00", "example-e.com"] },
    { "metrics": [0.105], "dimensions": ["2026-04-09 00:00:00", "example-a.com"] },
    { "metrics": [0.030], "dimensions": ["2026-04-09 00:00:00", "example-b.com"] },
    { "metrics": [0.024], "dimensions": ["2026-04-09 00:00:00", "example-c.com"] },
    { "metrics": [0.019], "dimensions": ["2026-04-09 00:00:00", "example-d.com"] },
    { "metrics": [0.013], "dimensions": ["2026-04-09 00:00:00", "example-e.com"] },
    { "metrics": [0.088], "dimensions": ["2026-04-10 00:00:00", "example-a.com"] },
    { "metrics": [0.026], "dimensions": ["2026-04-10 00:00:00", "example-b.com"] }
  ]
}
Use case: Monitor how citation share trends over time across competing domains.

​
Raw Data Access

Access unprocessed prompt and answer data for custom analysis. See the full endpoint reference for all available parameters and filters.
Get all visibility answers for a date range:
POST /v1/prompts/answers HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "filters": [
    {
      "field": "prompt_type",
      "operator": "is",
      "value": "visibility"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    {
      "created_at": "2026-01-01T08:15:00Z",
      "prompt": "What are the best project management tools?",
      "mentions": ["Company A", "Company B", "Company C"],
      "prompt_type": "open-ended",
      "response": "There are several leading project management tools available today. Company A offers comprehensive project tracking with built-in collaboration features...",
      "citations": ["https://www.example.com/reviews", "https://www.example.com/best-tools"],
      "themes": ["feature comparison", "pricing"],
      "topic": "Project Management",
      "region": "North America",
      "model": "ChatGPT",
      "model_id": "3f8a1b2c-1234-5678-abcd-ef0123456789",
      "asset": "Company A"
    },
    ...
  ]
}
Use case: Build custom dashboards and perform specialized analysis with raw answer data.