All API categories

    Interactions API

    11 endpoints

    Interaction tracking and analytics.

    POST
    Auth Required

    interactions.create

    interactions.create

    Endpoint

    /admin/collection/{collectionId}/interactions

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CreateInteractionTypeBody
    Required

    See CreateInteractionTypeBody schema

    Responses

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

    POST /admin/collection/:collectionId/interactions/query Flexible query for interaction events with optional includes.

    POST /admin/collection/:collectionId/interactions/query Flexible query for interaction events with optional includes.

    Endpoint

    /admin/collection/{collectionId}/interactions/counts-by-outcome

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    AdminInteractionsCountsByOutcomeRequest
    Required

    See AdminInteractionsCountsByOutcomeRequest schema

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    POST /admin/collection/:collectionId/interactions/query Flexible query for interaction events with optional includes.

    POST /admin/collection/:collectionId/interactions/query Flexible query for interaction events with optional includes.

    Endpoint

    /admin/collection/{collectionId}/interactions/query

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    AdminInteractionsQueryRequest
    Required

    See AdminInteractionsQueryRequest schema

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    interactions.get

    interactions.get

    Endpoint

    /admin/collection/{collectionId}/interactions/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

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

    interactions.update

    interactions.update

    Endpoint

    /admin/collection/{collectionId}/interactions/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    body
    body
    UpdateInteractionTypeBody
    Required

    See UpdateInteractionTypeBody schema

    Responses

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

    interactions.remove

    interactions.remove

    Endpoint

    /admin/collection/{collectionId}/interactions/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    interactions.list

    interactions.list

    Endpoint

    /admin/collection/{collectionId}/interactions/{qs}

    Parameters

    collectionId
    path
    string
    Required
    qs
    path
    string
    Required

    Responses

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

    interactions.publicMyInteractions

    interactions.publicMyInteractions

    Endpoint

    /public/collection/{collectionId}/interactions/by-user

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    PublicInteractionsByUserRequest
    Required

    See PublicInteractionsByUserRequest schema

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    interactions.publicCountsByOutcome

    interactions.publicCountsByOutcome

    Endpoint

    /public/collection/{collectionId}/interactions/counts-by-outcome

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    PublicInteractionsCountsByOutcomeRequest
    Required

    See PublicInteractionsCountsByOutcomeRequest schema

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    interactions.publicGet

    interactions.publicGet

    Endpoint

    /public/collection/{collectionId}/interactions/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

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

    interactions.publicList

    interactions.publicList

    Endpoint

    /public/collection/{collectionId}/interactions/{qs}

    Parameters

    collectionId
    path
    string
    Required
    qs
    path
    string
    Required

    Responses

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