Segments

Preview a segment expression.

Counts proven matches and unknown results, lists the first 25 matching contacts and the contacts currently reachable (confirmed; subscribed to the optional topic). Purchase conditions report the captured order period of every source they read. Preview and stored evaluation share the same compiled predicate.

post/segments/preview

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/segments/preview
  • Auth: API key in header X-API-Key

Query parameters

topicIdstring uuid

Request body

Example request

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

Response

Preview computed.

matchingCountinteger

Contacts proven to match the expression.

unknownCountinteger

Contacts whose purchase facts are still unknown for this expression.

reachableCountinteger

Matching contacts that are confirmed and, if a topic is given, subscribed to it.

Example response

{
  "captureScopes": [
    {
      "capturedOrdersFromUtc": "2022-03-10T16:15:50Z",
      "capturedOrdersToUtc": "2022-03-10T16:15:50Z",
      "attributionStartedAtUtc": "2022-03-10T16:15:50Z"
    }
  ]
}

Changes

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