Download OpenAPI specification:
API for Listening Post AI services, including leads, files and job tracking
Get the status of a job, including results if completed. Poll until "done" or "error" status is returned. Job ID is provided by report/run and report/export endpoints.
| id | string Return job status, ID is provided by report/run and report/export endpoints |
{- "id": 0,
- "status": "new",
- "results": { }
}Get signals for a report by ID, including how many of each signal were found in the report
| id required | string Report ID of the report you want to fetch signals for |
[- {
- "category": "string",
- "field": "string",
- "field_value": "string",
- "occurences": 0
}
]Get stats for a report by ID, including total, new, updated and unchanged entities
| id required | string Report ID of the report you want to fetch stats for |
[- {
- "batchId": 0,
- "total": 0,
- "new": 0,
- "updated": 0,
- "unchanged": 0
}
]Fetch first 10 leads of a report, good for confirming if the report is setup correctly.
| id required | string Report ID of the report you want to preview entities for |
[- {
- "entity_id": "string",
- "domains": { }
}
]Fetch entities from the latest report run, search, sort and page through all results.
| id required | string Report ID of the report you want to fetch entities for |
| offset | integer Offset for pagination, default is 0 |
| limit | integer Limit for pagination, default is 10, max is 100 |
| filter | object Filter set for the entity results, stringified JSON array [{"field":"status","operator":"=","value":"new"}] would show all new results. Domain fields can be accessed as field with |
| orderBy | object Order set for the entity results, stringified JSON array [{"field":"status","direction":"DESC"}] Would sort by status string descending. Direction (ASC|DESC) |
[- {
- "entity_id": "string",
- "domains": { }
}
]Fetch traits by entity type and query string. Traits describe an entity in terms of characteristics or intents.
| entity_type required | string Entity type, either "person" or "business" |
| qry required | string Natural language query string to search for matching traits |
| domains | Array of strings List of domains to search traits by ("intent", "demographics", etc.) |
[- {
- "trait_id": "string",
- "trait_hash": "string",
- "entity_type": "string",
- "domain": "string",
- "name": "string",
- "value": "string",
- "similarity_score": 0.1,
- "size": "string",
- "prevalence": 0.1,
- "updated_at": "2019-08-24T14:15:22Z"
}
]Various tools are available for finding and enriching leads, see the request body for details
| tool required | string |
string Email of the entity to enrich | |
| phone | string Phone number of the entity to enrich |
{- "tool": "entity_enrich",
- "email": "string",
- "phone": "string"
}[- {
- "entity_id": "string",
- "domains": { }
}
]