Sign in
Segments

Retrieve number of profiles based on set of segment rules

Retrieve the number of profiles produced by a set of segment rules.

post/audiences/{audienceId}/segments/queries

Path parameters

audienceIdinteger required

Master Segment id of the segment

Request body

columnsstring[]
realtimeboolean

use kind instead

kindinteger

0: batch, 1: realtime, 2: funnel_stage

pageSizeinteger
maxPageinteger
enableMvstring

"true", "false"

filterStringstring

Response

success

idstring

Query identifier (may be UUID or platform-specific ID like job ID or statement handle)

queryIdstring

Same value as id.

status'success' | 'killed' | 'error' | 'running'
countinteger nullable

Number of profiles produced by the given segment rules

maxPageinteger nullable
errorstring nullable
jobidstring integer
countJobidstring integer nullable
customerGroupCountinteger nullable

Number of customer groups related by the given segment rules

Changes

Changed in 1 of the 3 revisions of this API.1

  • 24caa8eb809b1See the full diff
    • ○

      api operation id segments#new_query removed and replaced with segments_new_query

      api-operation-id-removed