{
  "opencollection": "1.0.0",
  "info": {
    "name": "Campaigns Ad Servers Site Lists 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": "Site Lists",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Site Lists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/site_lists",
            "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 site lists. Site lists can be sorted and queried by fields:\n- `id`,\n- `version`,\n- `status`,\n- `organization_id`,\n- `name`,\n- `restriction`,\n- `filename`,\n- `content_updated_on`,\n- `sites_count`,\n- `created_on`,\n- `updated_on`.\n"
        },
        {
          "info": {
            "name": "Get Site List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/site_lists/:site_list_id",
            "params": [
              {
                "name": "site_list_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the site list to get"
              }
            ]
          },
          "docs": "Get a site list by ID"
        },
        {
          "info": {
            "name": "Upload New Site Lists",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/site_lists/upload",
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "organization_id",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "restriction",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "status",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Upload new site lists"
        },
        {
          "info": {
            "name": "Upload Updated Site Lists",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mediamath.com/api/v3.0/site_lists/:site_list_id/upload",
            "params": [
              {
                "name": "site_list_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the site list to get site list assignments"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "organization_id",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "restriction",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "status",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "version",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Upload updated site lists"
        },
        {
          "info": {
            "name": "Download Information for a Site List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/site_lists/:site_list_id/download.csv",
            "params": [
              {
                "name": "site_list_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the site list to get site list assignments"
              },
              {
                "name": "target_type",
                "value": "",
                "type": "query",
                "description": "Filter the sites download by a target type"
              }
            ]
          },
          "docs": "CSV download of site information for a site list"
        },
        {
          "info": {
            "name": "List Site List Assignments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mediamath.com/api/v3.0/site_lists/:site_list_id/assignments",
            "params": [
              {
                "name": "site_list_id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the site list to get site list assignments"
              },
              {
                "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 assignments for a site list"
        }
      ]
    }
  ],
  "bundled": true
}