{ "opencollection": "1.0.0", "info": { "name": "Campaigns Ad Servers Segment Groups API", "version": "3.0.1807" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.mediamath.com/authorize", "accessTokenUrl": "https://auth.mediamath.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Segment Groups", "type": "folder" }, "items": [ { "info": { "name": "List Segment Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/segment_groups", "params": [ { "name": "page_limit", "value": "", "type": "query", "description": "Number of elements in the collection to retrieve" }, { "name": "page_offset", "value": "", "type": "query", "description": "Index of the first element in the collection to retrieve" }, { "name": "sort_by", "value": "", "type": "query", "description": "The field to sort by. You can use any field name in ascending or descending order.\nFor ascending order, use the field name directly, e.g., `id`. \nFor descending order, prefix the field name with a hyphen (`-`), e.g., `-id`.\n" }, { "name": "q", "value": "", "type": "query", "description": "Query search for filtering. This parameter can be used to filter results based on various fields.\nSupported operators:\n- `==` - numeric equality or case-sensitive string identity, \n- `==(1,2,3)` - IN query (only works for integers),\n- `!=` - numeric inequality or case-sensitive string non-identity,\n- `=:` - case-insensitive match, allows substring using * wildcards,\n- `<` - less than,\n- `<=` - less than or equal to,\n- `>` - greater than,\n- `>=` - greater than or equal to.\nExamples: \n- `q=name=:{search}*` to find all results with names starting with {search}.\n- `q=status==true` to find all active entities.\n- `q=id>=1000` to find all entities with id greater than or equal to 1000.\n- `q=id==(1,2,3)` to find specific entities by ID.\n- `q=created_on>1999-02-02` or `q=created_on>1999-02-02T00:00:00Z` to find entities created later than date.\n- `q=id>5&status==true` to find all active entities with id greater than 5.\n" }, { "name": "extended", "value": "", "type": "query", "description": "Get extended properties in response" }, { "name": "currency_code", "value": "", "type": "query", "description": "Optional currency code to return segment group members in a specific currency.\nIf not provided or not found, the default currency (USD) will be used. \n" } ] }, "docs": "Get a list of segment groups" }, { "info": { "name": "Create a Segment Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.mediamath.com/api/v3.0/segment_groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a segment group" }, { "info": { "name": "Get a Segment Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/segment_groups/:segment_group_id", "params": [ { "name": "extended", "value": "", "type": "query", "description": "Get extended properties in response" }, { "name": "currency_code", "value": "", "type": "query", "description": "Optional currency code to return segment group members in a specific currency.\nIf not provided or not found, the default currency (USD) will be used. \n" }, { "name": "segment_group_id", "value": "", "type": "path", "description": "Numeric ID of the segment group to retrieve" } ] }, "docs": "Get a segment group by ID" }, { "info": { "name": "Update a Segment Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.mediamath.com/api/v3.0/segment_groups/:segment_group_id", "params": [ { "name": "segment_group_id", "value": "", "type": "path", "description": "Numeric ID of the segment group to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a segment group by ID" }, { "info": { "name": "Segment Groups Audit Log", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/segment_groups/:segment_group_id/history", "params": [ { "name": "page_limit", "value": "", "type": "query", "description": "Number of elements in the collection to retrieve" }, { "name": "page_offset", "value": "", "type": "query", "description": "Index of the first element in the collection to retrieve" }, { "name": "segment_group_id", "value": "", "type": "path", "description": "Numeric ID of the segment group" } ] }, "docs": "Get a list of changes to this segment group" }, { "info": { "name": "Get Segment Group Assignments", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/segment_groups/:segment_group_id/assignments", "params": [ { "name": "page_limit", "value": "", "type": "query", "description": "Number of elements in the collection to retrieve" }, { "name": "page_offset", "value": "", "type": "query", "description": "Index of the first element in the collection to retrieve" }, { "name": "segment_group_id", "value": "", "type": "path", "description": "Numeric ID of the segment group to retrieve assignments for" } ] }, "docs": "Get all assignments for a specific segment group" } ] } ], "bundled": true }