Segments

Create a segment

Save a named filter over your people. With groupId the segment belongs to that keyword group: it is listed, counted and changed only there, and its name only has to be unique in the group.

post/v1/segments

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/segments
  • Auth: HTTP bearer

Query parameters

groupIdstring

Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.

Request body

namestring required
descriptionstring

Response

The saved segment, with its current size

idstring required

Segment id (seg_...).

namestring required
descriptionstring required
groupIdstring nullable required

The group this segment belongs to, or null for a workspace segment.

countinteger required

People in the segment right now; it is evaluated on every read.

createdAtstring required

ISO 8601 timestamp, UTC.

updatedAtstring required

ISO 8601 timestamp, UTC.

Changes

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