MMetadata /docs
Docs/Tools/list_segments

list_segments

List pre-saved segments (reusable filter configurations).

Read audiences

Returns data. Calling it changes nothing, so it is safe in an unattended loop.

What it does

List pre-saved segments (reusable filter configurations).

RETURNS: Array of {id, name} objects.

NOTE: To use a segment's criteria with get_insights_report, call get_segment_criteria(segment_id) first.

WORKFLOW:
1. list_segments() or list_segments(name="keyword")
2. get_segment_criteria(segment_id)
3. get_insights_report(criteria=segment_criteria)

Arguments

ArgumentTypeNotes
name string Optional fuzzy search by name.
sort string Sort format: field,direction. Default: name,asc

Request

curl
curl -s -X POST https://mcp-server.metadata.io/mcp \
  -H "Authorization: $METADATA_PAT" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -H "MCP-Protocol-Version: 2025-11-25" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"list_segments","arguments":{}}}'

Response

Real, from the production server, in 327 ms. Values that identify a customer or disclose money are replaced with typed placeholders; keys, types and nesting are exactly as returned.

recorded response
"[value redacted]"

Other audiences tools:

All 160 tools · machine-readable index