Display & Video 360 (DBM) UI field names differ from their API names. Sometimes, those names are not intuitive and can significantly differ.
Moreover, not all metrics or dimensions can be obtained via API even though they are available in the interface. In addition to this, certain combination of metrics and dimensions cannot be obtained single API datastream. Rule of thumb in this case is: if the combination of metrics and dimension is allowed in the UI, then this should be allowed via API too.
Display & Video 360 (DBM) API is constantly being updated - this means that new fields are added, or new fields are available via API.
SCOPE OF THE DOCUMENT
The following document provides translation of field names from UI to API name grouped by available report types. Please note that also the report names differ between UI and API.
Please note that certain fields are marked in gray or black:
- invalid in combination with other fields (labeled with gray) and
- fields that are not available to select in Datatap datastream settings (labeled with black).
However, as the API constantly changes, it is possible that they will become available and supported at one point.
Please note that this list was generated in May 2019.
IF THE DOCUMENT DOESN'T LIST A NEEDED FIELD...
In case the list doesn't help, we can try to find out what it the API name for the selected fields from the report generated in the interface.
To query the reports ourselves we would need:
- authorization token and/or access credentials;
- report ID
Technical Support is in charge of querying the report.