USuseboom
Segments

Preview a segment filter

Changed on

Count how many people currently match a filter, without saving. Use it to check the audience before saving a segment.

post/api/v1/segments/preview

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Request body

includeBoomCreatedboolean

Count people Boom created for contacts who messaged you first, as a segment with includeBoomCreated would. False by default.

Response

Success

countinteger required

People currently matching the filter (capped when huge).

Changes

  • 7c7a773b12ceRevision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the // request property oneOf list

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the // request property oneOf list