Outbound

Get Analytics

Retrieves analytics data for a specific outbound campaign within a given date range.

post/v1/Outbound/{outboundId}/Analytics

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Outbound/:outboundId/Analytics/post.ts
A function with typed inputs. Its response is checked against the schema.

outboundIdstring required

The unique identifier of the outbound campaign.

fromstring date-time

The start date of the query range (inclusive).

tostring date-time

The end date of the query range (inclusive).
Must not be more than 90 days after the From date.

Returns an object containing the analytics data for the specified outbound campaign.

No recorded changes to this operation across all 1 revision of this API.