Skip to main content
API Reference8 min read

API Endpoints

Complete reference for all MeasureLLM API endpoints

Base URL

https://api.measurellm.com/api/v1

Keywords

List Keywords

GET/keywords

Returns a list of all keywords for your account.

Query Parameters

  • project_id - Filter by project (optional)
  • tag - Filter by tag (optional)
  • page - Page number (default: 1)
  • per_page - Results per page (default: 20, max: 100)

Response

{
  "data": [
    {
      "id": "kw_123abc",
      "keyword": "best crm software",
      "project_id": "proj_456",
      "platforms": ["chatgpt", "claude", "perplexity", "gemini"],
      "tags": ["product", "high-priority"],
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 45,
    "page": 1,
    "per_page": 20
  }
}

Get Keyword

GET/keywords/:id

Returns details for a specific keyword including latest visibility data.

Create Keyword

POST/keywords

Creates a new keyword to track.

Request Body

{
  "keyword": "best crm for startups",
  "project_id": "proj_456",
  "platforms": ["chatgpt", "claude", "perplexity"],
  "tags": ["product"]
}

Update Keyword

PATCH/keywords/:id

Updates an existing keyword.

Delete Keyword

DELETE/keywords/:id

Deletes a keyword. Historical data is retained for 30 days.

Visibility

Get Visibility Scores

GET/visibility

Returns visibility scores for all keywords.

Query Parameters

  • keyword_id - Filter to specific keyword (optional)
  • project_id - Filter by project (optional)
  • platform - Filter by platform (optional)
  • start_date - Start date for range (YYYY-MM-DD)
  • end_date - End date for range (YYYY-MM-DD)

Response

{
  "data": [
    {
      "keyword_id": "kw_123abc",
      "keyword": "best crm software",
      "visibility_score": 78,
      "platforms": {
        "chatgpt": 82,
        "claude": 75,
        "perplexity": 80,
        "gemini": 71
      },
      "mentions": 45,
      "citations": 12,
      "trend": "+12%",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 45,
    "page": 1,
    "per_page": 20
  }
}

Get Keyword Visibility

GET/visibility/:keyword_id

Returns detailed visibility data for a specific keyword.

Mentions

Get Mentions

GET/mentions

Returns brand mention data across AI platforms.

Response

{
  "data": [
    {
      "id": "mention_789",
      "keyword_id": "kw_123abc",
      "platform": "chatgpt",
      "position": 1,
      "sentiment": "positive",
      "context": "For CRM software, I recommend [YourBrand] because...",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 156,
    "page": 1,
    "per_page": 20
  }
}

Citations

Get Citations

GET/citations

Returns citation tracking data.

Response

{
  "data": [
    {
      "id": "cite_456",
      "keyword_id": "kw_123abc",
      "platform": "perplexity",
      "url": "https://yourbrand.com/guide/crm",
      "position": 2,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 89,
    "page": 1,
    "per_page": 20
  }
}

Competitors

List Competitors

GET/competitors

Returns competitor comparison data.

Create Competitor

POST/competitors

Adds a new competitor to track.

Projects

List Projects

GET/projects

Returns all projects in your account.

Create Project

POST/projects

Creates a new project.

Webhooks

List Webhooks

GET/webhooks

Returns registered webhooks.

Create Webhook

POST/webhooks

Registers a new webhook for alerts.

See Webhooks documentation for detailed webhook setup.

Error Responses

All errors return a consistent format:

{
  "error": {
    "code": "error_code",
    "message": "Human-readable error message",
    "details": {} // Optional additional information
  }
}

Common Error Codes

CodeStatusDescription
unauthorized401Invalid or missing API key
forbidden403Not authorized for this resource
not_found404Resource not found
validation_error422Invalid request parameters
rate_limited429Too many requests

Need help? Check out our API Overview for examples and best practices, or contact support for assistance.

Related Documentation