GET Custom Report Fields
Overview
The following table contains important information about the GET method in regards to receiving custom report fields.
| GET Custom Report Fields | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/custom-reports/fields |
| Headers | Authorization |
| Parameters | reportEntityType |
The description of the URL parameters is as follows:
| reportEntityType URL Parameter | |
|---|---|
| URL Parameter Name | reportEntityType |
| Mandatory | Yes |
| Type | integer ($int32) |
| Description |
|
note
Pick your desired number from the dropdown list at "reportEnitityType" parameter to access the specific fields.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"dimensions": {
"categories": [
{
"name": "Device",
"items": [
{
"display": "Devices",
"key": "devices"
},
{
"display": "Operating System",
"key": "operating_system"
},
{
"display": "Browser",
"key": "browser"
}
]
},
{
"name": "Content",
"items": [
{
"display": "Media",
"key": "media"
},
{
"display": "Player",
"key": "player"
},
{
"display": "Playlist",
"key": "playlist"
},
{
"display": "Date",
"key": "date"
}
]
},
{
"name": "Geography",
"items": [
{
"display": "Country",
"key": "country"
}
]
},
{
"name": "Placement",
"items": [
{
"display": "Host",
"key": "domain"
},
{
"display": "Host, Path & Query",
"key": "url"
},
{
"display": "Host & Path",
"key": "hostPath"
}
]
},
{
"name": "Project",
"items": [
{
"display": "Player ProjectId",
"key": "projectId"
},
{
"display": "Video ProjectId",
"key": "videoProjectId"
}
]
}
]
},
"metrics": {
"categories": [
{
"name": "Performance",
"items": [
{
"display": "Embeds",
"key": "embeds"
},
{
"display": "Ad Impressions",
"key": "ad_impressions"
},
{
"display": "Plays",
"key": "plays"
},
{
"display": "Completes",
"key": "completes"
},
{
"display": "Time Watched",
"key": "time_watched"
},
{
"display": "Average Watch Time",
"key": "avg_time_watched"
},
{
"display": "20s View",
"key": "20s-view"
},
{
"display": "True View\r\n",
"key": "true-view"
}
]
},
{
"name": "Viewers",
"items": [
{
"display": "Unique Viewers ",
"key": "unique_viewers"
},
{
"display": "Play per Viewer",
"key": "play_per_viewer"
},
{
"display": "Ad Impressions per Viewer ",
"key": "ad_impresions_per_viewer"
}
]
},
{
"name": "Engagement",
"items": [
{
"display": "Complete Rate",
"key": "complete_rate"
},
{
"display": "25% Completes",
"key": "25_completes"
},
{
"display": "50% Completes",
"key": "50_completes"
},
{
"display": "75% Completes",
"key": "75_completes"
}
]
},
{
"name": "Ads",
"items": [
{
"display": "Ad Clicks",
"key": "ad_clicks"
},
{
"display": "Ad Skips",
"key": "ad_skips"
},
{
"display": "Ad Completes",
"key": "ad_completes"
}
]
}
]
},
"dateRanges": [
{
"id": 1,
"name": "Custom"
},
{
"id": 2,
"name": "7 Days"
},
{
"id": 3,
"name": "30 Days"
},
{
"id": 4,
"name": "90 Days"
},
{
"id": 5,
"name": "Month to Date"
},
{
"id": 6,
"name": "Yesterday"
},
{
"id": 7,
"name": "Last Quarter"
},
{
"id": 8,
"name": "Last Month"
}
],
"filters": [
{
"id": 1,
"key": "video",
"display": "Videos"
},
{
"id": 2,
"key": "country",
"display": "Country"
},
{
"id": 3,
"key": "device",
"display": "Device"
},
{
"id": 4,
"key": "playlist",
"display": "Playlist"
},
{
"id": 5,
"key": "player",
"display": "Player"
},
{
"id": 6,
"key": "domain",
"display": "Domain"
},
{
"id": 7,
"key": "subtitles",
"display": "Subtitles"
},
{
"id": 8,
"key": "islive",
"display": "IsLive"
},
{
"id": 11,
"key": "videoprojectid",
"display": "Video Project Id"
}
]
},
"resultInfo": null,
"statusCode": 200
}
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| dimensions | Object | An object that contains the dimensions of the custom report. |
| categories | array | An array that contains the categories of a dimension of a custom report. |
| name | string | The name of the category. |
| items | array[Object] | An array that contains the items of a category. |
| display | string | The display of the item |
| key | string | The key of the item. |
| metrics | Object | An object that contains the metrics of the custom report. |
| dateRanges | array[Object] | An array of objects that contains the date ranges of the custom report. |
| id | integer($int32) | The ID of the date range. |
| name | string | The name of the date range |
| filters | array[Object] | An array of objects that contains the filters of the custom reports. |
| id | integer($int32) | The id of the filter. |
| key | string | The key of the filter. |
| display | string | The display of the filter. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed