Interface IStatisticClient

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IStatisticClient

Methods

AddContentEventsAsync(AddContentEventsRequest, CancellationToken)

Add content events

Declaration

Task<BusinessProcess> AddContentEventsAsync(AddContentEventsRequest request, CancellationToken cancellationToken = default)

Parameters

AddContentEventsRequest request Request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Remarks

Supply additional events from external sources. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

ExportContentStatisticsAsync(ExportContentStatisticsRequest, CancellationToken)

Export content statistics

Declaration

Task<BusinessProcess> ExportContentStatisticsAsync(ExportContentStatisticsRequest request, CancellationToken cancellationToken = default)

Parameters

ExportContentStatisticsRequest request Request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Remarks

Trigger export of statistical data for contents for further processing. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetSingleContentStatisticsAsync(string, IEnumerable<TimeSpan>, CancellationToken)

Retrieve single content statistics

Declaration

Task<ContentStatisticsAggregated> GetSingleContentStatisticsAsync(string contentId, IEnumerable<TimeSpan> timeFrames = null, CancellationToken cancellationToken = default)

Parameters

string contentId Id of Content

IEnumerable<TimeSpan> timeFrames Optionally aggregate data for given time frames

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ContentStatisticsAggregated>

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

ResolveDownloadLinkAsync(string, CancellationToken)

Resolve download link

Declaration

Task<DownloadLink> ResolveDownloadLinkAsync(string referenceId, CancellationToken cancellationToken = default)

Parameters

string referenceId Reference id

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DownloadLink> Download link information

Remarks

Resolve an actual Url to download exported file from referenceId found on completed BusinessProcess.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error