JSON:API resource identifier object used in relationships.
JSON:API object links with a required self URI.
JSON:API to-one relationship wrapper with non-null data when present.
Named relative timeframe supplied to Klaviyo reporting endpoints.
Custom reporting range supplied to Klaviyo reporting endpoints.
JSON:API error object returned by Klaviyo.
JSON:API error source pointer or parameter.
JSON:API resource object with typed attributes and relationships.
Empty relationship object for resources without documented relationships.
A tracking parameter whose value Klaviyo substitutes per send.
A tracking parameter carrying one fixed value on every send.
A static send timed against each recipient's own timezone.
A static send timed against one absolute instant for every recipient.
Raw groupings/statistics object returned by Klaviyo report APIs.
Campaign Values Report Request Attributes
Campaign report grouping dimensions supported by Klaviyo.
Flow report grouping dimensions supported by Klaviyo.
Pre-defined Klaviyo reporting timeframes.
Reporting statistics supported by Klaviyo campaign and flow reports.
Query alias: 2 models declare addTrackingParams.
Query alias: 1 model declares audiences.
Query alias: 1 model declares background.
Query alias: 3 models declare campaignId.
Query alias: 3 models declare campaignMessageId.
Query alias: 1 model declares campaignMessages.
Query alias: 2 models declare campaigns.
Query alias: 3 models declare catalogItemId.
Query alias: 3 models declare catalogVariantId.
Query alias: 1 model declares contentType.
Query alias: 3 models declare conversionMetricId.
Query alias: 1 model declares createdAt.
Query alias: 2 models declare customTrackingParams.
Query alias: 2 models declare dateTimes.
Query alias: 2 models declare description.
Query alias: 1 model declares editorType.
Query alias: 1 model declares enablementStatus.
Query alias: 1 model declares exclusive.
Query alias: 3 models declare externalId.
Query alias: 1 model declares firstName.
Query alias: 1 model declares flowActions.
Query alias: 3 models declare flowMessageId.
Query alias: 2 models declare flowMessages.
Query alias: 3 models declare flowTriggers.
Query alias: 2 models declare imageFullUrl.
Query alias: 2 models declare imageThumbnailUrl.
Query alias: 1 model declares integration.
Query alias: 1 model declares inventoryPolicy.
Query alias: 1 model declares inventoryQuantity.
Query alias: 1 model declares isProcessing.
Query alias: 1 model declares isStarred.
Query alias: 1 model declares isTrackingClicks.
Query alias: 1 model declares isTrackingOpens.
Query alias: 1 model declares lastEventDate.
Query alias: 1 model declares optInProcess.
Query alias: 1 model declares organization.
Query alias: 1 model declares parameter.
Query alias: 1 model declares phoneNumber.
Query alias: 1 model declares predictiveAnalytics.
Query alias: 3 models declare profileId.
Query alias: 1 model declares properties.
Query alias: 2 models declare published.
Query alias: 1 model declares pushTokens.
Query alias: 1 model declares recordedDate.
Query alias: 1 model declares scheduledAt.
Query alias: 3 models declare segmentId.
Query alias: 1 model declares sendOptions.
Query alias: 1 model declares sendPastRecipientsImmediately.
Query alias: 1 model declares sendStrategy.
Query alias: 1 model declares statusCode.
Query alias: 1 model declares subscriptions.
Query alias: 1 model declares throttlePercentage.
Query alias: 3 models declare timeframe.
Query alias: 1 model declares trackingOptions.
Query alias: 1 model declares triggerType.
Query alias: 2 models declare updatedAt.
Query alias: 3 models declare useSmartSending.
Query alias: 3 models declare windowEnd.
Query alias: 3 models declare windowStart.
Whether the campaign needs custom tracking parameters. If set to False, tracking params will not be used.
A list of custom tracking parameters. If an empty list is given and add_tracking_params is True, uses company defaults.
Whether the campaign is tracking click events. If not specified, uses company defaults.
Whether the campaign is tracking open events. If not specified, uses company defaults.
If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.
Whether the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.
Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends.
The percentage of recipients per hour to send to.