Interface VideoReportOptions

interface VideoReportOptions {
    endDate?: string;
    incrementDays?: number;
    maxResults?: number;
    onError?: (err: Error | ScrollError) => void;
    onProgress?: (
        items: VideoReportEntry[],
        current: number,
        total?: number,
    ) => void;
    onScrollError?: (err: ScrollError) => void;
    signal?: AbortSignal;
    sortDirection?: SortDirection;
    startDate?: string;
    videoIds?: string | string[];
}

Hierarchy (View Summary)

Properties

endDate? incrementDays? maxResults? onError? onProgress? onScrollError? signal? sortDirection? startDate? videoIds?

Properties

OptionalendDate

endDate?: string

OptionalincrementDays

incrementDays?: number

OptionalmaxResults

maxResults?: number

maximum number of search results

OptionalonError

onError?: (err: Error | ScrollError) => void

Search results use a scrollID cursor that expires after 1-5 minutes from first request. If the scrollID expires then onScrollExpired will be called with a ScrollError. Default behavior is to throw the error.

Note that request level errors (like 401 or 500) will just be thrown as normal, not passed to this function

OptionalonProgress

onProgress?: (
    items: VideoReportEntry[],
    current: number,
    total?: number,
) => void

callback per page

OptionalonScrollError

onScrollError?: (err: ScrollError) => void

Use onError instead

Deprecated

use onError instead

Optionalsignal

signal?: AbortSignal

OptionalsortDirection

sortDirection?: SortDirection

OptionalstartDate

startDate?: string

OptionalvideoIds

videoIds?: string | string[]

Settings

Member Visibility

On This Page

Properties