List User Permissions for an Agency

Organizations

Operations

Agencies

Operations

List Agencies

Request

Get a list of agencies

Security

Auth0

Query

page_limitinteger[ 1 .. 1000 ]

Number of elements in the collection to retrieve

Example: page_limit=100

page_offsetinteger[ 0 .. 1000 ]

Index of the first element in the collection to retrieve

Example: page_offset=0

sort_bystring

The field to sort by. You can use any field name in ascending or descending order. For ascending order, use the field name directly, e.g., id. For descending order, prefix the field name with a hyphen (-), e.g., -id.

Example: sort_by=id, -id, name, -name

qstring

Query search for filtering. This parameter can be used to filter results based on various fields.

q=name=:{search}* to find all results with names starting with "search".
q=status==true to find all active entities.
q=id>=1000 to find all entities with id greater than or equal to 1000.
q=id==(1,2,3) find specific entities by ID.

withstring

Get related property in response

Value"organization"

fullstring

To return all fields, set the value to *. For example, full=* will include all properties.

Example: full=*

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/agencies?page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string&with=organization&full=*' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List agencies response

Bodyapplication/json

One of:

dataArray of objects

metaobject(pagination metadata)

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Create an Agency

Request

Create an agency

Security

Auth0

Bodyapplication/jsonrequired

ads_txt_verifiedstring

Enum"ANY""AUTHORIZED_ONLY""AUTHORIZED_DIRECT_ONLY""NONE"

allow_x_adv_optimizationboolean

allow_x_adv_pixelsboolean

dmp_enabledstring

Enum"disabled""inherits"

eligible_for_data_sharingboolean

namestring[ 1 .. 64 ] charactersrequired

statusboolean

logostring<= 1024 characters

mfa_avoidancestring

Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"

organization_idinteger>= 1required

curl -i -X POST \
  https://api.mediamath.com/api/v3.0/agencies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ads_txt_verified": "ANY",
    "allow_x_adv_optimization": true,
    "allow_x_adv_pixels": true,
    "dmp_enabled": "disabled",
    "eligible_for_data_sharing": true,
    "name": "string",
    "status": true,
    "logo": "string",
    "mfa_avoidance": "INHERIT",
    "organization_id": 1
  }'

Responses

Agency created response

Bodyapplication/json

dataobject(agency_response_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "ads_txt_verified": "ANY",
    "allow_x_adv_optimization": true,
    "allow_x_adv_pixels": true,
    "dmp_enabled": "disabled",
    "eligible_for_data_sharing": true,
    "name": "string",
    "status": true,
    "logo": "string",
    "mfa_avoidance": "INHERIT",
    "id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "entity_type": "string",
    "organization_id": 1,
    "updated_on": "2019-08-24T14:15:22Z",
    "version": 0,
    "sales_contact_id": 0,
    "billing_contact_id": 0,
    "traffic_contact_id": 0
  },
  "meta": {
    "status": "success"
  }
}

Get an Agency

Request

Get an agency by ID

Security

Auth0

Path

agency_idintegerrequired

Numeric ID of the agency to get

Query

extendedboolean

Get extended properties in response

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/agencies/{agency_id}?extended=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Agency response

Bodyapplication/json

Any of:

dataobject(agency_response_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "ads_txt_verified": "ANY",
    "allow_x_adv_optimization": true,
    "allow_x_adv_pixels": true,
    "dmp_enabled": "disabled",
    "eligible_for_data_sharing": true,
    "name": "string",
    "status": true,
    "logo": "string",
    "mfa_avoidance": "INHERIT",
    "id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "entity_type": "string",
    "organization_id": 1,
    "updated_on": "2019-08-24T14:15:22Z",
    "version": 0,
    "sales_contact_id": 0,
    "billing_contact_id": 0,
    "traffic_contact_id": 0
  },
  "meta": {
    "status": "success"
  }
}

Update an Agency

Request

Update an agency by ID

Security

Auth0

Path

agency_idintegerrequired

Numeric ID of the agency to update

Bodyapplication/jsonrequired

ads_txt_verifiedstring

Enum"ANY""AUTHORIZED_ONLY""AUTHORIZED_DIRECT_ONLY""NONE"

allow_x_adv_optimizationboolean

allow_x_adv_pixelsboolean

dmp_enabledstring

Enum"disabled""inherits"

eligible_for_data_sharingboolean

namestring[ 1 .. 64 ] characters

statusboolean

logostring<= 1024 characters

mfa_avoidancestring

Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"

versioninteger

curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/agencies/{agency_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ads_txt_verified": "ANY",
    "allow_x_adv_optimization": true,
    "allow_x_adv_pixels": true,
    "dmp_enabled": "disabled",
    "eligible_for_data_sharing": true,
    "name": "string",
    "status": true,
    "logo": "string",
    "mfa_avoidance": "INHERIT",
    "version": 0
  }'

Responses

Agency updated response

Bodyapplication/json

dataobject(agency_response_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "ads_txt_verified": "ANY",
    "allow_x_adv_optimization": true,
    "allow_x_adv_pixels": true,
    "dmp_enabled": "disabled",
    "eligible_for_data_sharing": true,
    "name": "string",
    "status": true,
    "logo": "string",
    "mfa_avoidance": "INHERIT",
    "id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "entity_type": "string",
    "organization_id": 1,
    "updated_on": "2019-08-24T14:15:22Z",
    "version": 0,
    "sales_contact_id": 0,
    "billing_contact_id": 0,
    "traffic_contact_id": 0
  },
  "meta": {
    "status": "success"
  }
}

Agency Audit Log

Request

Get a list of changes to this agency

Security

Auth0

Path

agency_idintegerrequired

Numeric ID of the agency

Query

page_limitinteger[ 1 .. 1000 ]

Number of elements in the collection to retrieve

Example: page_limit=100

page_offsetinteger[ 0 .. 1000 ]

Index of the first element in the collection to retrieve

Example: page_offset=0

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/agencies/{agency_id}/history?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Audit log response

Bodyapplication/json

dataArray of objects or null

metaobject(pagination metadata)

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}