/** * Klaviyo API * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. * * Contact: developers@klaviyo.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ export declare class MetricAggregateQueryResourceObjectAttributes { /** * The metric ID used in the aggregation. */ 'metricId': string; /** * Optional pagination cursor to iterate over large result sets */ 'pageCursor'?: string; /** * Measurement key, e.g. `unique`, `sum_value`, `count` */ 'measurements': Array | Array<'count' | 'sum_value' | 'unique'>; /** * Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\" */ 'interval'?: MetricAggregateQueryResourceObjectAttributes.IntervalEnum | 'day' | 'hour' | 'month' | 'week' | null; /** * Alter the maximum number of returned rows in a single page of aggregation results */ 'pageSize'?: number | null; /** * Optional attribute(s) used for partitioning by the aggregation function */ 'by'?: Array | Array<'$attributed_channel' | '$attributed_flow' | '$attributed_message' | '$attributed_variation' | '$campaign_channel' | '$flow' | '$flow_channel' | '$message' | '$message_send_cohort' | '$usage_amount' | '$value_currency' | '$variation' | '$variation_send_cohort' | 'Bot Click' | 'Bounce Type' | 'Campaign Name' | 'Client Canonical' | 'Client Name' | 'Client Type' | 'Email Domain' | 'Failure Source' | 'Failure Type' | 'From Number' | 'From Phone Region' | 'Inbox Provider' | 'List' | 'Message Name' | 'Message Type' | 'Method' | 'Segment Count' | 'Subject' | 'To Number' | 'To Phone Region' | 'URL' | 'form_id'> | null; /** * Provide fields to limit the returned data */ 'returnFields'?: Array | null; /** * List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list. The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field. */ 'filter': Array; /** * The timezone used for processing the query, e.g. `\'America/New_York\'`. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones). While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive. */ 'timezone'?: string | null; /** * Provide a sort key (e.g. -$message) */ 'sort'?: MetricAggregateQueryResourceObjectAttributes.SortEnum | '$attributed_channel' | '-$attributed_channel' | '$attributed_flow' | '-$attributed_flow' | '$attributed_message' | '-$attributed_message' | '$attributed_variation' | '-$attributed_variation' | '$campaign_channel' | '-$campaign_channel' | '$flow' | '-$flow' | '$flow_channel' | '-$flow_channel' | '$message' | '-$message' | '$message_send_cohort' | '-$message_send_cohort' | '$usage_amount' | '-$usage_amount' | '$value_currency' | '-$value_currency' | '$variation' | '-$variation' | '$variation_send_cohort' | '-$variation_send_cohort' | 'Bot Click' | '-Bot Click' | 'Bounce Type' | '-Bounce Type' | 'Campaign Name' | '-Campaign Name' | 'Client Canonical' | '-Client Canonical' | 'Client Name' | '-Client Name' | 'Client Type' | '-Client Type' | 'Email Domain' | '-Email Domain' | 'Failure Source' | '-Failure Source' | 'Failure Type' | '-Failure Type' | 'From Number' | '-From Number' | 'From Phone Region' | '-From Phone Region' | 'Inbox Provider' | '-Inbox Provider' | 'List' | '-List' | 'Message Name' | '-Message Name' | 'Message Type' | '-Message Type' | 'Method' | '-Method' | 'Segment Count' | '-Segment Count' | 'Subject' | '-Subject' | 'To Number' | '-To Number' | 'To Phone Region' | '-To Phone Region' | 'URL' | '-URL' | 'count' | '-count' | 'form_id' | '-form_id' | 'sum_value' | '-sum_value' | 'unique' | '-unique'; static attributeTypeMap: Array<{ name: string; baseName: string; type: string; }>; static getAttributeTypeMap(): { name: string; baseName: string; type: string; }[]; } export declare namespace MetricAggregateQueryResourceObjectAttributes { enum MeasurementsEnum { Count, SumValue, Unique } enum IntervalEnum { Day, Hour, Month, Week } enum ByEnum { AttributedChannel, AttributedFlow, AttributedMessage, AttributedVariation, CampaignChannel, Flow, FlowChannel, Message, MessageSendCohort, UsageAmount, ValueCurrency, Variation, VariationSendCohort, BotClick, BounceType, CampaignName, ClientCanonical, ClientName, ClientType, EmailDomain, FailureSource, FailureType, FromNumber, FromPhoneRegion, InboxProvider, List, MessageName, MessageType, Method, SegmentCount, Subject, ToNumber, ToPhoneRegion, Url, FormId } enum SortEnum { AttributedChannel, AttributedChannelDesc, AttributedFlow, AttributedFlowDesc, AttributedMessage, AttributedMessageDesc, AttributedVariation, AttributedVariationDesc, CampaignChannel, CampaignChannelDesc, Flow, FlowDesc, FlowChannel, FlowChannelDesc, Message, MessageDesc, MessageSendCohort, MessageSendCohortDesc, UsageAmount, UsageAmountDesc, ValueCurrency, ValueCurrencyDesc, Variation, VariationDesc, VariationSendCohort, VariationSendCohortDesc, BotClick, BotClickDesc, BounceType, BounceTypeDesc, CampaignName, CampaignNameDesc, ClientCanonical, ClientCanonicalDesc, ClientName, ClientNameDesc, ClientType, ClientTypeDesc, EmailDomain, EmailDomainDesc, FailureSource, FailureSourceDesc, FailureType, FailureTypeDesc, FromNumber, FromNumberDesc, FromPhoneRegion, FromPhoneRegionDesc, InboxProvider, InboxProviderDesc, List, ListDesc, MessageName, MessageNameDesc, MessageType, MessageTypeDesc, Method, MethodDesc, SegmentCount, SegmentCountDesc, Subject, SubjectDesc, ToNumber, ToNumberDesc, ToPhoneRegion, ToPhoneRegionDesc, Url, UrlDesc, Count, CountDesc, FormId, FormIdDesc, SumValue, SumValueDesc, Unique, UniqueDesc } }