Analytics
GET Jobs#
Get all numbers of jobs by status.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/analytics/jobs |
| Headers | Authorization |
| Parameters | version, projectId, filter |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Filter | No | integer($int32) | 0 | It specifies the time interval for the filter to be applied on; lastHour=0, today=1, lastDay=2, lastWeek=3, lastMonth=4 |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "submitted": 0, "complete": 0, "processing": 0, "error": 0, "canceled": 0, "invalidRequest": 0, "partialyCompleted": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the job analytics result | |
| submitted | integer($int32) | 0 | Returns the number of jobs which have the status submitted |
| complete | integer($int32) | 0 | Returns the number of jobs which have the status complete |
| processing | integer($int32) | 0 | Returns the number of jobs which have the status processing |
| error | integer($int32) | 0 | Returns the number of jobs which have the status error |
| canceled | integer($int32) | 0 | Returns the number of jobs which have the status canceled |
| invalidRequest | integer($int32) | 0 | Returns the number of jobs which have the status invalidRequest |
| partialyCompleted | integer($int32) | 0 | Returns the number of jobs which have the status partialyCompleted |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Outputs#
Get all numbers of qualities by status.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/analytics/outputs |
| Headers | Authorization |
| Parameters | version, projectId, filter |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Filter | No | integer($int32) | 0 | It specifies the time interval for the filter to be applied on; lastHour=0, today=1, lastDay=2, lastWeek=3, lastMonth=4 |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "pending": 0, "complete": 0, "processing": 0, "error": 0, "canceled": 0, "invalidRequest": 0, "notApplicable": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the output analytics result | |
| pending | integer($int32) | 0 | Returns the number of qualities which have the status pending |
| complete | integer($int32) | 0 | Returns the number of qualities which have the status complete |
| processing | integer($int32) | 0 | Returns the number of qualities which have the status processing |
| error | integer($int32) | 0 | Returns the number of qualities which have the status error |
| canceled | integer($int32) | 0 | Returns the number of qualities which have the status canceled |
| invalidRequest | integer($int32) | 0 | Returns the number of qualities which have the status invalidRequest |
| notApplicable | integer($int32) | 0 | Returns the number of qualities which have the status notApplicable |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Average Times#
Get average time encoding in minutes for jobs and encoding output jobs.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/analytics/average-times |
| Headers | Authorization |
| Parameters | version, projectId, filter |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Filter | No | integer($int32) | 0 | It specifies the time interval for the filter to be applied on; lastHour=0, today=1, lastDay=2, lastWeek=3, lastMonth=4 |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "averageEncodingJobTime": 0, "averageEncodingOutputTime": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the average time analytics result | |
| averageEncodingJobTime | integer($int32) | 0 | The average time encoding in minutes for jobs |
| averageEncodingOutputTime | integer($int32) | 0 | The average time encoding in minutes for encoding output jobs |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Projects#
Get stats of project.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/analytics/projects |
| Headers | Authorization |
| Parameters | version, projectId, filter |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Filter | No | integer($int32) | 0 | It specifies the time interval for the filter to be applied on; lastHour=0, today=1, lastDay=2, lastWeek=3, lastMonth=4 |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "jobs": 0, "jobTemplates": 0, "outputGroups": 0, "presets": 0, "fileGroups": 0, "hls": 0, "dash": 0, "totalFileSizeEncoding": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the project analytics result | |
| jobs | integer($int32) | 0 | Returns the number of jobs for that particular project |
| jobTemplates | integer($int32) | 0 | Returns the number of template jobs for that particular project |
| outputGroups | integer($int32) | 0 | Returns the number of output groups for that particular project |
| presets | integer($int32) | 0 | Returns the number of presets for that particular project |
| fileGroups | integer($int32) | 0 | Returns the number of file groups for that particular project |
| hls | integer($int32) | 0 | Returns the number of hls groups for that particular project |
| dash | integer($int32) | 0 | Returns the number of dash groups for that particular project |
| totalFileSizeEncoding | integer($int32) | 0 | Returns the total file size encoding for that particular project |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Qualities#
Get encoding qualities.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/analytics/qualities |
| Headers | Authorization |
| Parameters | version, projectId, filter |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Filter | No | integer($int32) | 0 | It specifies the time interval for the filter to be applied on; lastHour=0, today=1, lastDay=2, lastWeek=3, lastMonth=4 |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "quality": "string", "averageTimeEncodingQuality": 0, "numberOfQualities": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the qualities analytics result | |
| quality | string | "string" | Returns the name of the quality |
| averageTimeEncodingQuality | integer($int32) | 0 | Returns the average time for encoding in a certain quality |
| numberOfQualities | integer($int32) | 0 | Returns the number of qualities |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Tags#
Get stats for tags.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/analytics/tags |
| Headers | Authorization |
| Parameters | version, projectId, filter, tagKey, tagValue |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Filter | No | integer($int32) | 0 | It specifies the time interval for the filter to be applied on; lastHour=0, today=1, lastDay=2, lastWeek=3, lastMonth=4 |
| TagKey | No | string | "string" | It specifies the key tag for the filter to be based on |
| TagValue | No | string | "string" | It specifies the value tag for the filter to be based on |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "quality": "string", "averageTimeEncodingQuality": 0, "numberOfQualities": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the tags analytics result | |
| quality | string | "string" | Returns the name of the quality |
| averageTimeEncodingQuality | integer($int32) | 0 | Returns the average time for encoding in a certain quality |
| numberOfQualities | integer($int32) | 0 | Returns the number of qualities |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden