Segment Groups

Get a Segment Group

Get a segment group by ID

get/segment_groups/{segment_group_id}

Request

Path parameters

segment_group_idinteger required

Numeric ID of the segment group to retrieve

Query parameters

extendedboolean

Get extended properties in response

currency_codestring
Example:USD

Optional currency code to return segment group members in a specific currency. If not provided or not found, the default currency (USD) will be used.

Response

Audience group response

Example response

{
  "data": {
    "name": "My Audience Group",
    "type": "CONTEXTUAL",
    "organization_id": 1234,
    "status": true,
    "segment_subgroup": [
      {
        "segment_operator": "AND",
        "segment_members": [
          {
            "name": "My Audience Group",
            "segment_id": 5678,
            "segment_type": "CONTEXTUAL",
            "full_path": "My Audience Group Parent - My Audience Group",
            "objective": "Custom",
            "cpm": 0.5,
            "code": "SEG123",
            "uniques": 1500
          }
        ]
      }
    ]
  },
  "meta": {
    "status": "success"
  }
}

Changes

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