MMetadata /docs
⌘K
Docs/Tools/get_segment_criteria

get_segment_criteria

Read one saved Insights segment by id or name: its criteria, status, and how many accounts it matches.

Read audiences

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

What it does

Read one saved Insights segment by id or name: its criteria, status, and how many accounts it matches. Pass lookback_window to count inside the window an audience would use.

RETURNS {found: true, id, name, status, last_updated_date, lookback_window, accounts, criteria}, or {found: false, available_segments: [...]} when nothing matches: pick from that list or create_segment, never invent an id.

STATUS: READY (usable), PENDING (a CRM field is still being extracted: wait and re-check), FAILED.

`accounts` is the number of companies matching right now (all time when lookback_window is omitted). 0 with the window you plan to use means create_audience_from_segment would build an empty audience: loosen the criteria (a new create_segment) or widen the window first.

Pass the returned `criteria` object (not the id) to get_insights_report to list the accounts.

Arguments

ArgumentTypeNotes
segment_id integer Segment ID (fastest lookup).
segment_name string Segment name (fuzzy matching, case-insensitive).
lookback_window integer Days to evaluate the segment over when counting accounts; use the window the audience will be created with.

Request

Request template, not a complete runnable example. Replace placeholders, empty objects, arrays, and zero values with valid account-specific inputs. Read required fields and nested constraints in the full schema. Confirm the account, connected channels, and referenced assets before calling a write tool.

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":"get_segment_criteria","arguments":{}}}'

Response

No recorded response. This tool needs arguments that only exist inside an account, so no response is recorded here. The request is an illustrative template. Fill required fields and check the current schema before calling it. No response is fabricated.

Other audiences tools:

Browse the tool catalog · machine-readable index