{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ad Servers Campaigns 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": "Campaigns",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Bulk Update Campaigns",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/bulk_update/campaigns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update multiple campaigns"
        },
        {
          "info": {
            "name": "Get a Specific Campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/campaigns/:campaign_id",
            "params": [
              {
                "name": "extended",
                "value": "",
                "type": "query",
                "description": "Get extended properties in response"
              },
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the campaign to get"
              }
            ]
          },
          "docs": "Get a campaign by ID"
        },
        {
          "info": {
            "name": "Update a Campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/campaigns/:campaign_id",
            "params": [
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the campaign to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a campaign by ID"
        },
        {
          "info": {
            "name": "List Campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/campaigns",
            "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": "with",
                "value": "",
                "type": "query",
                "description": "Get related property in response, values can be combined via `,` (example: `agency,advertiser`)"
              },
              {
                "name": "live_only",
                "value": "",
                "type": "query",
                "description": "If provided and true only campaigns with start_date < now and end_date > now will be returned. \nDefault value is false. Cannot be combined with filter_expired=true.\n"
              },
              {
                "name": "filter_expired",
                "value": "",
                "type": "query",
                "description": "If provided and true only campaigns with end_date > now will be returned. \nDefault value is false. Cannot be combined with live_only=true.\n"
              }
            ]
          },
          "docs": "Get a list of campaigns. The data fetched for each campaign depends on the values of query params. For example, if you use query parameter `full` all properties are fetched."
        },
        {
          "info": {
            "name": "Create a Campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/campaigns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a campaign"
        },
        {
          "info": {
            "name": "Campaign Audit Log",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/campaigns/:campaign_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": "campaign_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the campaign"
              }
            ]
          },
          "docs": "Get a list of changes made to this campaign"
        },
        {
          "info": {
            "name": "(Legacy) Update Specific Campaign Dynamic Budget Allocation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/campaigns/:campaign_id/dynamic_budget_allocation",
            "params": [
              {
                "name": "full",
                "value": "",
                "type": "query",
                "description": "To return all fields, set the value to `*`. For example, `full=*` will include all properties.\n"
              },
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the campaign"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Legacy Endpoint - To be removed"
        },
        {
          "info": {
            "name": "Copy a Campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/campaigns/:campaign_id/copy",
            "params": [
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the campaign object"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Copy a campaign"
        },
        {
          "info": {
            "name": "Update Campaign Dynamic Budget Allocation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/campaign_dba",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This end point is restricted to a specific service account"
        },
        {
          "info": {
            "name": "List User Permissions for a Campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/campaigns/:campaign_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": "campaign_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the campaign"
              }
            ]
          },
          "docs": "List user permissions for an campaign"
        },
        {
          "info": {
            "name": "Bulk Campaign Audit Log",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/audit_log/campaigns",
            "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 campaigns"
        }
      ]
    }
  ],
  "bundled": true
}