Bulk Export Deals

POST https://app.usehindsight.com/api/v1/deals/export
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Request body:
{
  "columns": ["name", "amount", "deal_status", "proposal_due", ...],  // Array of column IDs to include
  "filters": {                                                          // Optional filters
    "deal_ids": ["deal_123", "deal_456"],                              // Specific deal IDs
    "owner_ids": ["user_abc"],                                         // Deal owner IDs
    "status": ["Won", "Lost"],                                         // Deal stages (Hindsight stage values)
    "close_date": {                                                     // Date range
      "from": "2026-01-01",
      "to": "2026-03-31"
    },
    "amount": {                                                // Deal size range
      "min": 10000,
      "max": 100000
    },
    "competitors": ["comp_123"],                                       // Competitor IDs (any competitor on deal)
    "deal_type": ["New Business", "Expansion"],                        // Deal types
    "region": ["North America", "EMEA"],                               // Regions
    "industry": ["Technology", "Finance"],                             // Industries
    "product_labels": ["Product A"],                                   // Product labels
    "analyzed": true,                                                  // Only analyzed deals
    "verified": true                                                   // Only verified analyses
  }
}

200 Response:
{
  "success": true,
  "export_id": "exp_abc123",
  "status": "pending",
  "message": "Export job started successfully"
}

GET https://app.usehindsight.com/api/v1/deals/export/{export_id}
200 Response:
{
  "export_id": "exp_abc123",
  "status": "completed | pending | failed",
  "download_url": "https://app.usehindsight.com/api/v1/deals/export/exp_abc123/download?token=...",  // Available when status is "completed"
  "rows_exported": 150,
  "created_at": "2026-03-10T12:00:00Z",
  "completed_at": "2026-03-10T12:02:30Z",
  "expires_at": "2026-03-17T12:02:30Z"  // Download URL expires in 7 days
}

Rate limits: Per-minute (10/60/300 req/min for Essentials/Growth/Enterprise) + monthly quota per route.

​

Overview

• Creating custom reports for leadership
• Exporting data for external analysis tools
• Generating filtered deal lists for specific time periods or segments
• Backing up deal data

​

Request Format

​

Required Fields

​

Optional Filters

​

Deal Identification

​

People & Ownership

​

Deal Attributes

Note on status values: status filters come from your your specific workspace configuration.

​

Date & Amount Filters

​

Competitive Intelligence

​

Analysis Filters

​

CRM Filters (Advanced)

​

Filter Type Modifiers

{
  "competitors": ["comp_123", "comp_456"],
  "competitors_filter_type": "include all of"
}

​

Available Columns

​

Standard Columns

Note: The scorecard column includes all win-loss metrics (product fit, sales execution, relationship, price sensitivity, competitive intensity, customer fit, messaging fit, and messaging accuracy) with both scores and explanations.

​

Dynamic Columns

​

CRM Deal Properties

• Format: crm_{property_id}
• Example: crm_lead_source, crm_sales_rep_region

​

CRM Account Properties

• HubSpot format: crm_hubspot_account_{property_id}
• Salesforce format: crm_salesforce_account_{property_id}
• Examples: crm_hubspot_account_industry, crm_salesforce_account_annual_revenue

​

Custom Metrics

• Score format: custom_metric_score_{metric_name}
• Explanation format: custom_metric_explanation_{metric_name}
• Example: For a custom metric called “Strategic Fit”: custom_metric_score_Strategic Fit or custom_metric_explanation_StrategicFit

​

Custom Answers

• Format: custom_answer_{answer_name}
• Example: custom_answer_Champion identified or custom_answer_ChampionIdentified for a custom question called “Champion identified”

​

Response

​

Initial Response (POST)

{
  "success": true,
  "export_id": "exp_abc123",
  "status": "pending",
  "message": "Export job started successfully"
}

​

Checking Export Status (GET)

GET /api/v1/deals/export/{export_id}

{
  "export_id": "exp_abc123",
  "status": "pending",
  "created_at": "2026-03-10T12:00:00Z"
}

{
  "export_id": "exp_abc123",
  "status": "completed",
  "download_url": "https://app.usehindsight.com/api/v1/deals/export/exp_abc123/download?token=...",
  "rows_exported": 150,
  "created_at": "2026-03-10T12:00:00Z",
  "completed_at": "2026-03-10T12:02:30Z",
  "expires_at": "2026-03-17T12:02:30Z"
}

{
  "export_id": "exp_abc123",
  "status": "failed",
  "error": "Export failed: Invalid column ID 'invalid_column'",
  "created_at": "2026-03-10T12:00:00Z",
  "failed_at": "2026-03-10T12:01:15Z"
}

​

Download URL Expiration

• Download URLs are valid for 7 days after generation
• After expiration, you’ll need to create a new export request
• The export record remains accessible via GET for 30 days

​

CRM Filters

{
  "salesforce_filters_account": [
    {
      "property": { "id": "Account.Industry", "map_to": "industry" },
      "operator": "is",
      "value": "COMPUTER_SOFTWARE"
    }
  ],
  "salesforce_filters": [
    {
      "property": { "id": "Amount" },
      "operator": "is greater than",
      "value": "50000"
    }
  ]
}

{ "property": { "id": "field_name" } }

{
  "property": {
    "id": "Account.Industry",
    "map_to": "industry"
  }
}

• is, is not
• is greater than, is less than
• is greater than or equal to, is less than or equal to
• is before, is after (for dates)
• contains, does not contain (for text)

​

Rate Limits

​

Examples

curl -X POST https://app.usehindsight.com/api/v1/deals/export \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "columns": ["name", "amount", "deal_status", "proposal_due", "owner_id"]
  }'

​

Best Practices

1. Column Selection: Only request columns you need to minimize export size and processing time
2. Polling Interval: Wait 5-10 seconds between status checks to avoid rate limiting
3. Download Promptly: Download the file within 7 days before the URL expires
4. Filter Early: Apply filters to reduce export size rather than filtering after download
5. Pagination Alternative: For real-time data access, consider using the paginated /deals endpoint instead

​

Error Responses

{
  "error": "Invalid column IDs: unknown_column, invalid_field",
  "status": 400
}

["name", "amount", "stage", "close_date"]