Skip to content

README.md

Latest commit

 

History

History
75 lines (51 loc) · 12.5 KB

README.md

File metadata and controls

75 lines (51 loc) · 12.5 KB
Raw

Errors

Overview

Operations involving errors

Available Operations

list_errors

This endpoint returns the total number of playback errors that occurred, along with the total number of views captured, based on the specified timespan and filters. It provides insights into the overall playback quality and helps identify potential issues that may impact viewer experience.

Key fields in response

  • percentage: The percentage of views affected by the specific error.
  • uniqueViewersEffectedPercentage: The percentage of unique viewers affected by the specific error (available only in the topErrors section).
  • notes: Additional notes or information about the specific error.
  • message: The error message or description.
  • lastSeen: The timestamp of when the error was last observed.
  • id: The unique identifier for the specific error.
  • description: A description of the specific error.
  • count: The number of occurrences of the specific error.
  • code: The error code associated with the specific error.

Related guide: Troubleshoot errors

Example Usage

require 'json'
require 'fastpixapi'

Models = ::FastpixClient::Models
s = ::FastpixClient::Fastpixapi.new(
      security: Models::Components::Security.new(
        username: 'your-access-token',
        password: 'your-secret-key',
      ),
    )

res = s.errors.list_errors(timespan: Models::Operations::ListErrorsTimespan::TWENTY_FOURHOURS, filterby: 'browser_name:Chrome', limit: 1)

begin
  puts JSON.pretty_generate(JSON.parse(res.raw_response.body))
rescue FastpixClient::Models::Errors::APIError => e
  puts JSON.pretty_generate(JSON.parse(e.body))
rescue StandardError
  puts res.raw_response.body.to_s
end

Parameters

Parameter Type Required Description Example
timespan T.nilable(Models::Operations::ListErrorsTimespan) ➖ This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.

Accepted formats are:

array of epoch timestamps for example
timespan[]=1498867200&timespan[]=1498953600

duration string for example
timespan[]=24:hours or timespan[]=7:days
 24:hours
filterby T.nilable(::String) ➖ Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
 browser_name:Chrome
limit T.nilable(::Integer) ➖ Pass the limit to display only the rows specified by the value for top errors.
 1

Response

T.nilable(Models::Operations::ListErrorsResponse)

Errors

Error Type Status Code Content Type
Errors::APIError 4XX, 5XX */*