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 metric to sort embed locations by.
 */
export declare const GetAnalyticsMediasMediaIdEmbedLocationsSortBy: {
    readonly Plays: "plays";
    readonly Loads: "loads";
    readonly EngagementRate: "engagement_rate";
    readonly PlayRate: "play_rate";
};
/**
 * The metric to sort embed locations by.
 */
export type GetAnalyticsMediasMediaIdEmbedLocationsSortBy = ClosedEnum<typeof GetAnalyticsMediasMediaIdEmbedLocationsSortBy>;
/**
 * The sort direction.
 */
export declare const GetAnalyticsMediasMediaIdEmbedLocationsSortDirection: {
    readonly Asc: "asc";
    readonly Desc: "desc";
};
/**
 * The sort direction.
 */
export type GetAnalyticsMediasMediaIdEmbedLocationsSortDirection = ClosedEnum<typeof GetAnalyticsMediasMediaIdEmbedLocationsSortDirection>;
export type GetAnalyticsMediasMediaIdEmbedLocationsRequest = {
    /**
     * 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 metric to sort embed locations by.
     */
    sortBy?: GetAnalyticsMediasMediaIdEmbedLocationsSortBy | undefined;
    /**
     * The sort direction.
     */
    sortDirection?: GetAnalyticsMediasMediaIdEmbedLocationsSortDirection | undefined;
    /**
     * Filter results to a single embed URL. When provided, only analytics for
     *
     * @remarks
     * the page matching this URL are returned. Must be a valid HTTP or HTTPS URL.
     */
    embedUrl?: string | undefined;
    /**
     * Number of results to return (max 100).
     */
    perPage?: number | undefined;
};
export type GetAnalyticsMediasMediaIdEmbedLocationsResponse = {
    /**
     * The domain where the video is embedded.
     */
    embedDomain?: string | undefined;
    /**
     * The path on the domain where the video is embedded.
     */
    embedPath?: string | undefined;
    /**
     * The full URL where the video is embedded.
     */
    embedUrl?: string | undefined;
    /**
     * The title of the page where the video is embedded.
     */
    pageTitle?: string | undefined;
    /**
     * The number of video loads from this location.
     */
    loads?: number | undefined;
    /**
     * The number of unique video loads from this location (one per visitor session).
     */
    uniqueLoads?: number | undefined;
    /**
     * The number of video plays from this location.
     */
    plays?: number | undefined;
    /**
     * The number of unique video plays from this location (one per visitor session).
     */
    uniquePlays?: number | undefined;
    /**
     * The play rate from this location (between 0 and 1).
     */
    playRate?: number | undefined;
    /**
     * Total time spent watching from this location in seconds.
     */
    playedTime?: number | undefined;
    /**
     * The average engagement rate from this location (between 0 and 1).
     */
    engagementRate?: number | undefined;
    /**
     * The number of unique visitors from this location.
     */
    uniqueVisitors?: number | undefined;
    /**
     * The CTA conversion rate from this location (between 0 and 1).
     */
    ctaConversionRate?: number | undefined;
};
/** @internal */
export declare const GetAnalyticsMediasMediaIdEmbedLocationsSortBy$outboundSchema: z.ZodNativeEnum<typeof GetAnalyticsMediasMediaIdEmbedLocationsSortBy>;
/** @internal */
export declare const GetAnalyticsMediasMediaIdEmbedLocationsSortDirection$outboundSchema: z.ZodNativeEnum<typeof GetAnalyticsMediasMediaIdEmbedLocationsSortDirection>;
/** @internal */
export type GetAnalyticsMediasMediaIdEmbedLocationsRequest$Outbound = {
    mediaId: string;
    start_date: string;
    end_date: string;
    sort_by: string;
    sort_direction: string;
    embed_url?: string | undefined;
    per_page: number;
};
/** @internal */
export declare const GetAnalyticsMediasMediaIdEmbedLocationsRequest$outboundSchema: z.ZodType<GetAnalyticsMediasMediaIdEmbedLocationsRequest$Outbound, z.ZodTypeDef, GetAnalyticsMediasMediaIdEmbedLocationsRequest>;
export declare function getAnalyticsMediasMediaIdEmbedLocationsRequestToJSON(getAnalyticsMediasMediaIdEmbedLocationsRequest: GetAnalyticsMediasMediaIdEmbedLocationsRequest): string;
/** @internal */
export declare const GetAnalyticsMediasMediaIdEmbedLocationsResponse$inboundSchema: z.ZodType<GetAnalyticsMediasMediaIdEmbedLocationsResponse, z.ZodTypeDef, unknown>;
export declare function getAnalyticsMediasMediaIdEmbedLocationsResponseFromJSON(jsonString: string): SafeParseResult<GetAnalyticsMediasMediaIdEmbedLocationsResponse, SDKValidationError>;
//# sourceMappingURL=getanalyticsmediasmediaidembedlocations.d.ts.map