All API categories

    Journey Analytics API

    3 endpoints

    Journey performance analytics.

    POST
    Auth Required

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/steps/:stepId/recipients Returns recipient IDs for a given journey step.

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/steps/:stepId/recipients Returns recipient IDs for a given journey step.

    Endpoint

    /admin/collection/{collectionId}/journeys.analytics/{journeyId}/funnel-report

    Parameters

    collectionId
    path
    string
    Required
    journeyId
    path
    string
    Required
    body
    body
    JourneyFunnelReportRequest
    Required

    See JourneyFunnelReportRequest schema

    Responses

    200
    Success
    {
  "schema": "JourneyFunnelReportResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats Computes journey stats over a time window; outcome defaults to 'success'.

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats Computes journey stats over a time window; outcome defaults to 'success'.

    Endpoint

    /admin/collection/{collectionId}/journeys.analytics/{journeyId}/stats

    Parameters

    collectionId
    path
    string
    Required
    journeyId
    path
    string
    Required
    body
    body
    JourneyStatsRequest
    Required

    See JourneyStatsRequest schema

    Responses

    200
    Success
    {
  "schema": "JourneyStatsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats Computes journey stats over a time window; outcome defaults to 'success'.

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats Computes journey stats over a time window; outcome defaults to 'success'.

    Endpoint

    /admin/collection/{collectionId}/journeys.analytics/{journeyId}/steps/{stepId}/recipients

    Parameters

    collectionId
    path
    string
    Required
    journeyId
    path
    string
    Required
    stepId
    path
    string
    Required
    body
    body
    JourneyStepRecipientsRequest
    Required

    See JourneyStepRecipientsRequest schema

    Responses

    200
    Success
    {
  "schema": "JourneyStepRecipientsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found