Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

Query cancel survey responses

Returns a paginated list of cancel survey responses submitted within a specific date range.

Results can be filtered by startDate, endDate, and optionally by productPath.

Supports sorting by creationTime or reasonId, in ascending or descending order.

post/subscriptions/cancelSurvey/response/query

Request body

startDatestring date-time required

Start of the query window (ISO 8601 format).

endDatestring date-time required

End of the query window (ISO 8601 format).

productPathstring

Optional filter to limit results to a specific product.

Example request

{
  "startDate": "2025-01-01T00:00:00Z",
  "endDate": "2026-01-31T23:59:59Z",
  "productPath": "my-product-path",
  "pagination": {
    "limit": 30
  },
  "sorting": {
    "field": "creationTime",
    "order": "desc"
  }
}

Response

OK

totalRecordsinteger

Total number of matching cancel survey records.

totalPagesinteger

Number of pages based on totalRecords and page size.

Example response

{
  "totalRecords": 3,
  "totalPages": 1,
  "surveys": [
    {
      "id": "2cDfgHIjKLmNOPqRs_tUV",
      "subscriptionId": "aBCDE12fGH3iJkL4mNOpqr",
      "reasonId": "7",
      "name": "other",
      "displayName": "Other",
      "lang": "en",
      "description": "Other",
      "feedbackText": "We decided to switch to another tool that better meets our integration needs.",
      "site": "ABC0DE1GHIJ2",
      "productPath": "fastspring-falcon",
      "creationTime": "Tue Mar 25 17:27:52 UTC 2025"
    }
  ]
}