{ "opencollection": "1.0.0", "info": { "name": "Campaigns Ad Servers Strategy Parameters 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": "Strategy Parameters", "type": "folder" }, "items": [ { "info": { "name": "List Strategy Deals", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_deals", "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": "with", "value": "", "type": "query", "description": "Get related property in response" }, { "name": "full", "value": "", "type": "query", "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n" } ] }, "docs": "Get a list of strategy deals" }, { "info": { "name": "List Strategy Day Parts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_day_parts", "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": "full", "value": "", "type": "query", "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n" } ] }, "docs": "Get a list of strategy day parts" }, { "info": { "name": "List Strategy Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_groups" }, "docs": "Get a list of strategy groups for a specific campaign" }, { "info": { "name": "List Strategy IP Addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_ip_addresses", "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": "full", "value": "", "type": "query", "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n" } ] }, "docs": "Get a list of strategy IP addresses with default sort by `id DESC`. Can be queried by:\n- `id`,\n- `version`,\n- `target_inet` with type IP/CIDR for all operators except search `=:`,\n- `strategy_id` is required,\n- `created_on`,\n- `updated_on`\nand can be sorted by:\n- `id`,\n- `version`,\n- `target_inet`,\n- `strategy_id`,\n- `created_on`,\n- `updated_on`.\n" }, { "info": { "name": "Download Information for a Strategy IP addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_ip_addresses/:strategy_id/download.csv", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy to get IP addresses" } ] }, "docs": "CSV download of IP addresses for a strategy" }, { "info": { "name": "List Strategy Concepts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_concepts", "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": "full", "value": "", "type": "query", "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n" }, { "name": "extended", "value": "", "type": "query", "description": "Get extended properties in response" } ] }, "docs": "Get a list of strategy concepts" }, { "info": { "name": "List Strategy Target Values", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_target_values", "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": "full", "value": "", "type": "query", "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n" } ] }, "docs": "Get a list of strategy target values" }, { "info": { "name": "List Strategy Postal Codes", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_postal_codes", "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": "full", "value": "", "type": "query", "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n" } ] }, "docs": "Get a list of strategy postal codes with default sort by `id DESC`. Can be queried by:\n- `id`,\n- `name`,\n- `value`,\n- `code`,\n- `exclude`,\n- `strategy_id` is required\nand can be sorted by:\n- `id`,\n- `name`,\n- `value`,\n- `code`,\n- `strategy_id`.\n" }, { "info": { "name": "Download Information for a Strategy Postal Codes", "type": "http" }, "http": { "method": "GET", "url": "https://api.mediamath.com/api/v3.0/strategy_postal_codes/:strategy_id/download.csv", "params": [ { "name": "strategy_id", "value": "", "type": "path", "description": "Numeric ID of the strategy to get postal codes" } ] }, "docs": "CSV download of postal codes for a strategy" } ] } ], "bundled": true }