{ "opencollection": "1.0.0", "info": { "name": "Campaigns Ad Servers Strategies 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": "Strategies", "type": "folder" }, "items": [ { "info": { "name": "List Strategies", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies", "params": [ { "name": "with", "value": "", "type": "query", "description": "Get related property in response" }, { "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": "full", "value": "", "type": "query", "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n" }, { "name": "live_only", "value": "", "type": "query", "description": "If provided and true only strategies with start_date < now and end_date > now will be returned. \nDefault value is false. \nIf use_campaign_start = true campaign.start_date will be used instead of one from strategy.\nIf use_campaign_end = true campaign.end_date will be used instead of one from strategy.\n" } ] }, "docs": "Get a list of strategies" }, { "info": { "name": "Create a Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://api.mediamath.com/api/v3.0/strategies", "params": [ { "name": "extended", "value": "", "type": "query", "description": "Get extended properties in response" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a strategy. \nIf your use case requires more than 100,000 IPs or postal codes, please contact your MediaMath representative to discuss custom solutions or alternative approaches.\n" }, { "info": { "name": "Get a Strategy", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy object to get" }, { "name": "extended", "value": "", "type": "query", "description": "Get extended properties in response" } ] }, "docs": "Get a strategy by ID" }, { "info": { "name": "Update a Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy to update" }, { "name": "extended", "value": "", "type": "query", "description": "Get extended properties in response" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a strategy by ID.\nIf your use case requires more than 100,000 IPs or postal codes, please contact your MediaMath representative to discuss custom solutions or alternative approaches.\n" }, { "info": { "name": "Copy a strategy", "type": "http" }, "http": { "method": "POST", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id/copy", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy object" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copy a strategy" }, { "info": { "name": "Get Strategy Health", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id/healthcheck", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy object" } ] }, "docs": "Get strategy health" }, { "info": { "name": "Get Targeting Friendly Names", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id/friendly_names", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy object" } ] }, "docs": "Get targeting friendly names" }, { "info": { "name": "Get Forecast Query", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id/forecast_query", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy object" } ] }, "docs": "Get forecast query" }, { "info": { "name": "Get Targeting Expression", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id/targeting_expression", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy object" }, { "name": "include_inactive", "value": "", "type": "query", "description": "When true, includes inactive supply sources and strategy targets in the expression. Default behavior filters these out." } ] }, "docs": "Get the normalized targeting expression for a strategy." }, { "info": { "name": "Strategy Audit Log", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_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": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy" } ] }, "docs": "Get a list changes to this strategy" }, { "info": { "name": "Bulk Update Strategies", "type": "http" }, "http": { "method": "POST", "url": "https://api.mediamath.com/api/v3.0/bulk_update/strategies", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple strategies" }, { "info": { "name": "List User Permissions for a Strategy", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategies/:strategy_id/permissions", "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": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy" } ] }, "docs": "List user permissions for a strategy" }, { "info": { "name": "Bulk Strategy Audit Log", "type": "http" }, "http": { "method": "POST", "url": "https://api.mediamath.com/api/v3.0/audit_log/strategies", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get a list of changes to these strategies" } ] } ], "bundled": true }