API Reference
Integrate Resultid's operational intelligence into your existing workflows and systems.
Authentication
All API requests require a Bearer token in the Authorization header. Tokens are scoped to your organization and can be created in Settings.
Generate an access token using your API key and secret.
curl -X POST https://api.resultid.com/v1/auth/token \
-H "Content-Type: application/json" \
-d '{
"api_key": "your_api_key",
"api_secret": "your_api_secret"
}'Quick Start
Get up and running with three API calls: authenticate, create a source, and query your first insight.
SDKs & Libraries
Official client libraries for Python, Node.js, Go, and Java. Community libraries available for Ruby and PHP.
List Sources
Retrieve all connected data sources for your organization.
Returns a paginated list of data sources.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (default: 1) |
| per_page | integer | No | Results per page (default: 25, max: 100) |
| status | string | No | Filter by status: active, paused, error |
curl https://api.resultid.com/v1/sources \
-H "Authorization: Bearer YOUR_TOKEN"Create Source
Connect a new data source to your organization.
Create and configure a new data source connection.
curl -X POST https://api.resultid.com/v1/sources \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Customer Reviews - US",
"type": "google_reviews",
"config": {
"location_ids": ["loc_123", "loc_456"]
}
}'Source Status
Check the health and sync status of a specific data source.
Returns current sync status and last successful ingestion timestamp.
Webhooks
Receive real-time notifications when new data is ingested or intelligence is generated.
Register a new webhook endpoint.
curl -X POST https://api.resultid.com/v1/webhooks \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"url": "https://your-app.com/webhooks/resultid",
"events": ["insight.created", "action.triggered"]
}'Remove a registered webhook.
Query Intelligence
Query the intelligence layer for insights across your connected data sources.
Execute an intelligence query with filters and parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| sources | string[] | Yes | Array of source IDs to query |
| time_range | string | No | Time range: 7d, 30d, 90d, 1y (default: 30d) |
| dimensions | string[] | No | Group results by dimension |
| limit | integer | No | Max results (default: 25, max: 500) |
curl -X POST https://api.resultid.com/v1/intelligence/query \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"sources": ["src_123"],
"time_range": "30d",
"dimensions": ["location", "category"],
"limit": 50
}'Insight Objects
Retrieve individual insight objects with full detail and attribution.
Fetch a specific insight by ID.
List insights with optional filtering.
Filters & Parameters
Reference for all available query filters, sort options, and aggregation parameters.
List Actions
Retrieve prioritized actions generated from your intelligence data.
Returns a paginated list of actions sorted by priority.
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | No | Filter: open, in_progress, resolved, dismissed |
| priority | string | No | Filter: critical, high, medium, low |
Action Status
Update the status of an action as your team works through the queue.
Update action status or assignment.
curl -X PUT https://api.resultid.com/v1/actions/act_789 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "in_progress",
"assigned_to": "user_456"
}'Priority Actions
Access the filtered set of highest-priority actions requiring immediate attention.
Returns top priority actions across all sources.
Rate Limits
API rate limits are enforced per organization.
| Tier | Rate | Burst | Notes |
|---|---|---|---|
| Standard | 100 req/min | 200 req/min | Default for all organizations |
| Enterprise | Custom | Custom | Contact your account manager |
Error Codes
Standard HTTP status codes with Resultid-specific error detail objects.
| Code | Name | Description |
|---|---|---|
| 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Missing or invalid authentication token |
| 403 | Forbidden | Insufficient permissions for this resource |
| 404 | Not Found | Resource does not exist |
| 429 | Rate Limited | Too many requests -- retry after cooldown |
| 500 | Internal Error | Server error -- contact support if persistent |
Best Practices
Recommendations for efficient API usage, caching strategies, and webhook reliability.
Next step
Questions? Talk to our team.
Your existing data. No new surveys. No integrations. No consultants.
30
days to first insight
0
new data collected
$107M+
surfaced at one OEM
No integration required · GDPR-compliant · If we can’t show you revenue you didn’t know was there, you’ll know in the first meeting.