Taxonomy

This API is based on the taxonomy sections of the Adshares protocol.

First, read about authorization and error handling.

Media

GET /api/v2/taxonomy/media

Fetch supported media.

Request Headers:

• Accept – application/json

Status Codes:

• 200 OK – no error

Response JSON Object:

• data (object) – map of supported media. Key is medium ID. Value is medium name

Vendors

GET /api/v2/taxonomy/media/(medium)/vendors

Fetch supported vendors by medium.

Parameters:

• medium – medium ID

Request Headers:

• Accept – application/json

Status Codes:

• 200 OK – no error

Response JSON Object:

• data (object) – map of supported vendors. Key is vendor ID. Value is vendor name

Taxonomy by medium

GET /api/v2/taxonomy/media/(medium)

Fetch taxonomy for medium.

Parameters:

• medium – medium ID

Query Parameters:

• vendor – (optional) vendor ID. If omitted, default vendor will be returned

Request Headers:

• Accept – application/json

Status Codes:

• 200 OK – no error

Response JSON Object:

• data (Taxonomy) – taxonomy

Data structures

Taxonomy object

• name (string) – medium name

• label (string) – medium label

• vendor (string) – vendor name

• vendorLabel (string) – vendor label

• formats[].type (string) – format type

• formats[].mimes (string[]) – MIME types

• formats[].scopes (object) – map of scopes. Key is the scope. Value is a label

• targeting.user (TargetingOption[]) – (optional) user targeting options

• targeting.site (TargetingOption[]) – (optional) site targeting options

• targeting.device (TargetingOption[]) – (optional) device targeting options