Sign in

v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
flow_sessions

List flow sessions

get/flow_sessions

Query parameters

subscriber_idstring

Filter flow sessions by subscriber ID

subscription_idstring

Filter flow sessions by subscription ID

status'saved' | 'deflected' | 'canceled' | 'incomplete'

Filter flow sessions by status

started_atstring

Filter flow sessions by the started_at property. Specify as a dictionary with one or more of the following properties:

  • started_at[gt] — Return flow sessions where started_at is greater than this value
  • started_at[lt] — Return flow sessions where started_at is less than this value
  • started_at[gte] — Return flow sessions where started_at is greater than or equal to this value
  • started_at[lte] — Return flow sessions where started_at is less than or equal to this value

Specify date values in ISO 8601 format.

completed_atstring

Filter flow sessions by the completed_at property. Specify as a dictionary with one or more of the following properties:

  • completed_at[gt] — Return flow sessions where completed_at is greater than this value
  • completed_at[lt] — Return flow sessions where completed_at is less than this value
  • completed_at[gte] — Return flow sessions where completed_at is greater than or equal to this value
  • completed_at[lte] — Return flow sessions where completed_at is less than or equal to this value

Specify date values in ISO 8601 format.

updated_atstring

Filter flow sessions by the updated_at property. Specify as a dictionary with one or more of the following properties:

  • updated_at[gt] — Return flow sessions where updated_at is greater than this value
  • updated_at[lt] — Return flow sessions where updated_at is less than this value
  • updated_at[gte] — Return flow sessions where updated_at is greater than or equal to this value
  • updated_at[lte] — Return flow sessions where updated_at is less than or equal to this value

Specify date values in ISO 8601 format.

cursorstring

Pagination cursor to retrieve

limitinteger

Limit of flow sessions to return

Response

OK

next_cursorstring nullable

Example response

{
  "data": [
    {
      "id": "sess_eoTR48bvoOCd7SxXAKRrPhj0",
      "status": "saved",
      "flow": {
        "id": "flow_3Aree3otQWV2qXhFiehIIQpA",
        "name": "Default"
      },
      "subscriber": {
        "id": "subr_dRiytWmkVtSBt9mOpRaC0ca0",
        "platform_id": "cus_Jax42BBWGOWuDp",
        "name": "Jane Doe",
        "email": "jane@example.com",
        "status": "saved",
        "properties": [
          {
            "property": {
              "id": "prop_jrtpyZs1httwFFIl7V80cHwf",
              "key": "number_of_contacts",
              "name": "Number of contacts",
              "type": "number",
              "format": "number"
            },
            "formatted_value": "5,800"
          }
        ]
      },
      "subscription": {
        "id": "subn_dp79dRR5wIy1kGW4PCO41wit",
        "platform_id": "sub_JE1trB8eUAnh0r",
        "subscriber_id": "subr_GQmXBebvivMb5tHhassNV9kj",
        "mrr": "399.95",
        "status": "active",
        "properties": [
          {
            "property": {
              "id": "prop_S6A17y8S8wgKBBJbveQHpLW6",
              "key": "is_professional",
              "name": "Is professional",
              "type": "boolean",
              "format": "null"
            },
            "formatted_value": "True"
          }
        ]
      },
      "offers_presented": [
        {
          "id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
          "name": "40% off",
          "details": {
            "interval": "month",
            "interval_count": 3
          }
        }
      ],
      "offer_groups_presented": [
        {
          "id": "ofgr_8t5SRZsHgeVI4u8aKXxs8tIQ",
          "name": "Win-back bundle",
          "offers": [
            {
              "id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
              "name": "40% off",
              "details": {
                "interval": "month",
                "interval_count": 3
              }
            }
          ]
        }
      ],
      "offer_accepted": {
        "id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
        "name": "40% off",
        "details": {
          "interval": "month",
          "interval_count": 3
        }
      },
      "answers": [
        {
          "question": {
            "id": "ques_By8b753fR4egFkzaJ8wBGK70",
            "text": "What is your primary reason for leaving?"
          },
          "value": {
            "id": "qopt_Jv3WHts65H9Iwz6bNcuBSapF",
            "text": "Too expensive"
          },
          "sentiment": "null"
        }
      ],
      "steps": [
        {
          "step": {
            "id": "step_S3biU4JN09ie6p52eIk3SWF3",
            "type": "question",
            "title": "What is your primary reason for leaving?"
          }
        }
      ],
      "cancel_reason": {
        "text": "Too expensive",
        "reason_code": "too_expensive"
      },
      "deflected_by": {
        "type": "deflection",
        "details": {
          "deflection": {
            "id": "defl_qvNg13Ydk3N9C5Pw5AgTSfFU",
            "name": "Account snapshot",
            "actions": [
              {
                "id": "act_VkdRnVeN13G8eyehniYVP9ty",
                "code": "support_chat",
                "type": "url",
                "details": {
                  "url": "https://acme.com/?action=support_chat"
                }
              }
            ]
          },
          "action": {
            "id": "act_VkdRnVeN13G8eyehniYVP9ty",
            "code": "support_chat",
            "type": "url",
            "details": {
              "url": "https://acme.com/?action=support_chat"
            }
          }
        }
      }
    }
  ],
  "next_cursor": "null"
}