import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { RFCDate } from "../../types/rfcdate.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * The time granularity for the timeseries data. */ export declare const GetAnalyticsMediasMediaIdTimeseriesGranularity: { readonly Daily: "daily"; readonly Weekly: "weekly"; readonly Monthly: "monthly"; }; /** * The time granularity for the timeseries data. */ export type GetAnalyticsMediasMediaIdTimeseriesGranularity = ClosedEnum; export type GetAnalyticsMediasMediaIdTimeseriesRequest = { /** * The hashed ID of the video. */ mediaId: string; /** * Start date for the analytics period in ISO 8601 format (YYYY-MM-DD). Inclusive — the range starts at the beginning of this date. */ startDate: RFCDate; /** * End date for the analytics period in ISO 8601 format (YYYY-MM-DD). Exclusive — the range ends before the beginning of this date. */ endDate: RFCDate; /** * The time granularity for the timeseries data. */ granularity: GetAnalyticsMediasMediaIdTimeseriesGranularity; }; export type GetAnalyticsMediasMediaIdTimeseriesResponse = { /** * The start of the time bucket in ISO 8601 format. */ timestamp?: Date | undefined; /** * The number of unique video loads. */ uniqueLoads?: number | null | undefined; /** * The number of unique video plays. */ uniquePlays?: number | null | undefined; /** * The total number of video plays. */ plays?: number | null | undefined; /** * The percentage of loads that resulted in a play (between 0 and 1). */ playRate?: number | null | undefined; /** * Total time spent watching the video in seconds. */ playedTime?: number | null | undefined; /** * The number of unique visitors who loaded the video. */ uniqueVisitors?: number | null | undefined; /** * The average percentage of the video watched (between 0 and 1). */ engagementRate?: number | null | undefined; /** * The number of times a call-to-action was shown. */ ctaImpressions?: number | null | undefined; /** * The number of times a call-to-action was clicked. */ ctaConversions?: number | null | undefined; /** * The rate of CTA clicks over impressions (between 0 and 1). */ ctaConversionRate?: number | null | undefined; /** * The number of form submissions. */ formConversions?: number | null | undefined; }; /** @internal */ export declare const GetAnalyticsMediasMediaIdTimeseriesGranularity$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetAnalyticsMediasMediaIdTimeseriesRequest$Outbound = { mediaId: string; start_date: string; end_date: string; granularity: string; }; /** @internal */ export declare const GetAnalyticsMediasMediaIdTimeseriesRequest$outboundSchema: z.ZodType; export declare function getAnalyticsMediasMediaIdTimeseriesRequestToJSON(getAnalyticsMediasMediaIdTimeseriesRequest: GetAnalyticsMediasMediaIdTimeseriesRequest): string; /** @internal */ export declare const GetAnalyticsMediasMediaIdTimeseriesResponse$inboundSchema: z.ZodType; export declare function getAnalyticsMediasMediaIdTimeseriesResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getanalyticsmediasmediaidtimeseries.d.ts.map