v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Pitch Workspace

Get Pitch Report

Returns a single pitch report by ID, including the company metadata, generated prompts, tracked competitors, brand and competitor attributes, top citing sources, and aggregate metrics (brand mentions, sentiment, response rate).

Requires a global (organization-scoped) API key. Website-scoped keys are rejected with 403 Forbidden. Returns 404 Not Found if the pitch does not exist, has been deleted, or belongs to a different organization.

get/api/v1/pitches/{pitch_id}

Path parameters

pitch_idstring uuid required

The UUID of the pitch to retrieve.

Response

Successful response with the full pitch report.

Example response

{
  "pitch": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Acme Inc",
    "company_url": "acme.com",
    "company_description": "Acme Inc sells durable industrial widgets to manufacturers.",
    "status": "completed",
    "created_at": "2026-05-22T15:04:05.000Z",
    "country": "United States",
    "language": "en",
    "type": "pitch_workspace"
  },
  "competitors": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "name": "Competitor Co",
      "url": "competitor.com",
      "mentions": 42,
      "sentiment": 67
    }
  ],
  "prompts": [
    {
      "id": "22222222-3333-4444-5555-666666666666",
      "prompt": "What are the best industrial widget manufacturers?",
      "type": "discovery"
    }
  ],
  "attributes": [
    {
      "id": "33333333-4444-5555-6666-777777777777",
      "attribute_name": "Reliable delivery",
      "attribute_type": "positive",
      "applies_to": "target",
      "count": 12
    }
  ],
  "sources": [
    {
      "domain": "wikipedia.org",
      "mentions": 18
    }
  ],
  "metrics": {
    "total_responses": 120,
    "brand_mentions": 64,
    "sentiment_score": 72,
    "response_rate": 53
  }
}