Subscribers

Retrieve subscribers matching a segment expression

Applies the current SegmentExpression condition-group model with status and pagination options. Conditions inside one group use AND; groups use OR. Field conditions use subjectType FIELD with fieldRef. Tag conditions use subjectType TAGS and tag IDs in operand.optionIds. Nested segment conditions use subjectType SEGMENT and operand.segmentId.

post/subscribers/filtered

Request

  • Base URL: https://api.maildroppa.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.maildroppa.com/subscribers/filtered
  • Auth: API key in header X-API-Key

Query parameters

pageNumberinteger

Page number.

pageSizeinteger

Number of items per page.

statusstring

Subscriber status filter.

Request body

Example request

{
  "conditionGroups": [
    {
      "conditions": [
        {
          "operand": {
            "date": "2022-03-10",
            "purchase": {
              "period": {
                "from": "2022-03-10",
                "to": "2022-03-10"
              }
            }
          }
        }
      ]
    }
  ]
}

Response

Subscribers retrieved successfully.

pageNumberinteger

Which page is this (1-based index)?

pageSizeinteger

Number of items per page.

totalItemsinteger

Total number of items matching the query.

totalPagesinteger

Total number of pages based on page size.

Example response

{
  "items": [
    {
      "lastImportedAtUtc": "2022-03-10T16:15:50Z"
    }
  ]
}

Changes

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