Getting Started
Overview
The BIGDBM API suite lets you query behavioral intent signals, resolve identifiers, and enrich profiles, all over HTTPS using JSON payloads. Every response includes structured data you can pipe directly into your CRM, CDP, or data warehouse.
- Query consumer intent by keyword, date range, and volume
- Enrich emails, phones, addresses, MAIDs, and IPs in real time
- Receive hashed email (HEM) lists for audience activation
- All endpoints return standard JSON with consistent error shapes
Base URL
https://aws-behavioral-intent-api.bigdbm.com
All API requests must be made over HTTPS. HTTP requests will be rejected. API keys are issued per account and scoped to the products you have licensed.
Security
Authentication
All BIGDBM API endpoints require a Bearer token passed in the Authorization header.
Authorization: Bearer YOUR_TOKEN
Tokens are issued by your BIGDBM account representative. Each token is scoped to specific API products and rate limits. Do not share tokens or commit them to version control, use environment variables or a secrets manager.
- Tokens do not expire on a fixed schedule, but can be rotated on request
- Each token is tied to your organization and audit-logged
- A missing or invalid token returns
401 Unauthorized
Endpoint
Behavioral Intent API
The Behavioral Intent API lets you build audiences based on real consumer search and browsing intent. Submit a keyword and date range to receive a list of hashed email addresses (HEMs) representing consumers who expressed matching intent signals.
POST /intent/createList
Creates an intent-based audience list and returns matching HEMs for activation or enrichment.
Request Example
curl --location 'https://aws-behavioral-intent-api.bigdbm.com/intent/createList' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --data '{ "StartDate": "2025-12-03", "EndDate": "2025-12-03", "Keywords": "audi", "NumberOfHems": 1000 }'
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| StartDate | string | Required | Start of the intent signal window. Format: YYYY-MM-DD. Must be within the last 90 days. |
| EndDate | string | Required | End of the intent signal window. Format: YYYY-MM-DD. Must be >= StartDate. |
| Keywords | string | Required | Keyword or phrase representing the consumer intent to match. Examples: "audi", "mortgage refinance", "electric vehicle". |
| NumberOfHems | integer | Required | Maximum number of hashed email addresses to return. Min: 100, Max: 100000. Actual count may be lower depending on signal volume. |
Sample Response
{ "status": "success", "listId": "lst_7f3a9b2c4d1e", "query": { "StartDate": "2025-12-03", "EndDate": "2025-12-03", "Keywords": "audi", "NumberOfHems": 1000 }, "count": 1000, "hems": [ { "hem": "a3f4e8b7c2d1901ef56a3b2c4d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5", "signal_date": "2025-12-03", "confidence": 0.94, "signal_count": 7 }, { "hem": "b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4", "signal_date": "2025-12-03", "confidence": 0.88, "signal_count": 3 }, // ... up to 1000 results ], "metadata": { "processing_ms": 143, "keyword_match_pool": 48291, "api_version": "2025-01" } }
Endpoint
Enrichment APIs
The BIGDBM Enrichment API resolves any input identifier, email, phone, postal address, MAID, or IP address, into a verified set of identity attributes with confidence scores. Responses are returned in under 200ms for real-time use cases.
- Email enrichment, append name, address, phone, demographics
- Phone enrichment, append owner identity, address, carrier
- Address enrichment, append occupants, emails, phones, household data
- MAID enrichment, resolve mobile ad IDs to person records
- IP enrichment, resolve IPs to household or device-level identity
All enrichment endpoints follow the same authentication pattern. Contact your account representative for endpoint-specific documentation and to enable enrichment products.
Reference
Response Codes
All BIGDBM API endpoints return standard HTTP status codes. Errors include a message field with a human-readable description.
| Code | Meaning | Notes |
|---|---|---|
| 200 OK | Success | Request was processed successfully. Check the status field for application-level results. |
| 400 Bad Request | Invalid parameters | A required parameter is missing, malformed, or out of range. Check the message field for details. |
| 401 Unauthorized | Authentication failed | Bearer token is missing, expired, or invalid. Verify your token in the Authorization header. |
| 429 Too Many Requests | Rate limit exceeded | You have exceeded the request rate for your plan. Check the Retry-After header and implement exponential backoff. |
| 500 Internal Server Error | Server error | An unexpected error occurred. These are rare, retry with backoff. If persistent, contact support. |
Ready to integrate?
Request API credentials and get started building with BIGDBM's data products today.
Get API Access