Skip to content

Latest commit

 

History

History
328 lines (233 loc) · 16 KB

README.md

File metadata and controls

328 lines (233 loc) · 16 KB
Raw

Metrics

(metrics())

Overview

Operations related to metrics api

Available Operations

getRealtimeViewership

Requires a private (non-CORS) API key to be used.

Example Usage

package hello.world;

import java.lang.Exception;
import java.util.List;
import studio.livepeer.livepeer.Livepeer;
import studio.livepeer.livepeer.models.errors.SDKError;
import studio.livepeer.livepeer.models.operations.BreakdownBy;
import studio.livepeer.livepeer.models.operations.GetRealtimeViewershipNowResponse;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Livepeer sdk = Livepeer.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            GetRealtimeViewershipNowResponse res = sdk.metrics().getRealtimeViewership()
                .playbackId("<value>")
                .creatorId("<value>")
                .breakdownBy(List.of(
                    BreakdownBy.PLAYBACK_ID))
                .call();

            if (res.data().isPresent()) {
                // handle response
            }
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
playbackId Optional ➖ The playback ID to filter the query results. This can be a canonical
playback ID from Livepeer assets or streams, or dStorage identifiers
for assets
creatorId Optional ➖ The creator ID to filter the query results
breakdownBy List<BreakdownBy> ➖ The list of fields to break down the query results. Specify this
query-string multiple times to break down by multiple fields.

Response

GetRealtimeViewershipNowResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*

getViewership

Requires a private (non-CORS) API key to be used.

Example Usage

package hello.world;

import java.lang.Exception;
import studio.livepeer.livepeer.Livepeer;
import studio.livepeer.livepeer.models.errors.SDKError;
import studio.livepeer.livepeer.models.operations.GetViewershipMetricsRequest;
import studio.livepeer.livepeer.models.operations.GetViewershipMetricsResponse;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Livepeer sdk = Livepeer.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            GetViewershipMetricsRequest req = GetViewershipMetricsRequest.builder()
                .build();

            GetViewershipMetricsResponse res = sdk.metrics().getViewership()
                .request(req)
                .call();

            if (res.data().isPresent()) {
                // handle response
            }
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
request GetViewershipMetricsRequest ✔️ The request object to use for the request.

Response

GetViewershipMetricsResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*

getCreatorViewership

Requires a proof of ownership to be sent in the request, which for now is just the assetId or streamId parameters (1 of those must be in the query-string).

Example Usage

package hello.world;

import java.lang.Exception;
import studio.livepeer.livepeer.Livepeer;
import studio.livepeer.livepeer.models.errors.SDKError;
import studio.livepeer.livepeer.models.operations.GetCreatorViewershipMetricsRequest;
import studio.livepeer.livepeer.models.operations.GetCreatorViewershipMetricsResponse;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Livepeer sdk = Livepeer.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            GetCreatorViewershipMetricsRequest req = GetCreatorViewershipMetricsRequest.builder()
                .build();

            GetCreatorViewershipMetricsResponse res = sdk.metrics().getCreatorViewership()
                .request(req)
                .call();

            if (res.data().isPresent()) {
                // handle response
            }
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
request GetCreatorViewershipMetricsRequest ✔️ The request object to use for the request.

Response

GetCreatorViewershipMetricsResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*

getPublicViewership

Allows querying for the public metrics for viewership about a video. This can be called from the frontend with a CORS key, or even unauthenticated.

Example Usage

package hello.world;

import java.lang.Exception;
import studio.livepeer.livepeer.Livepeer;
import studio.livepeer.livepeer.models.errors.SDKError;
import studio.livepeer.livepeer.models.operations.GetPublicViewershipMetricsResponse;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Livepeer sdk = Livepeer.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            GetPublicViewershipMetricsResponse res = sdk.metrics().getPublicViewership()
                .playbackId("<value>")
                .call();

            if (res.data().isPresent()) {
                // handle response
            }
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
playbackId String ✔️ The playback ID to filter the query results. This can be a canonical
playback ID from Livepeer assets or streams, or dStorage identifiers
for assets

Response

GetPublicViewershipMetricsResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*

getUsage

Query usage metrics

Example Usage

package hello.world;

import java.lang.Exception;
import studio.livepeer.livepeer.Livepeer;
import studio.livepeer.livepeer.models.errors.SDKError;
import studio.livepeer.livepeer.models.operations.GetUsageMetricsRequest;
import studio.livepeer.livepeer.models.operations.GetUsageMetricsResponse;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Livepeer sdk = Livepeer.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            GetUsageMetricsRequest req = GetUsageMetricsRequest.builder()
                .build();

            GetUsageMetricsResponse res = sdk.metrics().getUsage()
                .request(req)
                .call();

            if (res.usageMetric().isPresent()) {
                // handle response
            }
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
request GetUsageMetricsRequest ✔️ The request object to use for the request.

Response

GetUsageMetricsResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*