API docs by Redocly

Listening Post API (0.0.1)

Download OpenAPI specification:

Listening Post, Inc.: support@listeningpost.ai

API for Listening Post AI services, including leads, files and job tracking

jobs

Job tracking

Status of a job

Authorizations:
Authorization
query Parameters
id
string

Return job status, ID is provided by report/run and report/export endpoints

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "new",
  • "results": { }
}

file

File info

Fetch a URL to download a file

Authorizations:
Authorization
query Parameters
id
required
string

File ID of the file you want a download URL for

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

reports

Report tracking

List of saved reports

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a report by ID

Authorizations:
Authorization
path Parameters
id
required
string

Report ID of the report you want to fetch details for

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "settings": { },
  • "nodes": [
    ]
}

Get signals for a report by ID

Authorizations:
Authorization
path Parameters
id
required
string

Report ID of the report you want to fetch signals for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get stats for a report by ID

Authorizations:
Authorization
path Parameters
id
required
string

Report ID of the report you want to fetch stats for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch first 10 leads of a report, good for confirming it is working as expected

Authorizations:
Authorization
path Parameters
id
required
string

Report ID of the report you want to preview entities for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch entities from the latest report run

Authorizations:
Authorization
path Parameters
id
required
string

Report ID of the report you want to fetch entities for

query Parameters
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 . splits (e.g. "addresses.state") Valid operators ('=','!=','<','>','<=','>=')

orderBy
object

Order set for the entity results, stringified JSON array [{"field":"status","direction":"DESC"}] Would sort by status string descending. Direction (ASC|DESC)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

traits

Traits describe an entity in terms of characteristics or intents

Get an entity by domain

Authorizations:
Authorization
query Parameters
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.)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

leads

Direct access to leads calls

Fetch leads based on report criteria

Authorizations:
Authorization
Request Body schema: application/json
required
tool
required
string
email
string

Email of the entity to enrich

phone
string

Phone number of the entity to enrich

Responses

Request samples

Content type
application/json
Example
{
  • "tool": "entity_enrich",
  • "email": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]