feat: add report metrics endpoint#163
Open
chougron wants to merge 1 commit into
Open
Conversation
mike-engel
requested changes
May 8, 2026
Comment on lines
+28
to
+76
| export interface ReportEmailMetricsRequestData { | ||
| delivery_id: string; | ||
| metric: 'bounced' | 'clicked' | 'converted' | 'deferred' | 'delivered' | 'dropped' | 'opened' | 'spammed'; | ||
| timestamp?: number; | ||
| recipient?: string; | ||
| reason?: string; | ||
| href?: string; | ||
| } | ||
| export interface ReportInappMetricsRequestData { | ||
| delivery_id: string; | ||
| metric: 'clicked' | 'converted' | 'opened'; | ||
| timestamp?: number; | ||
| recipient?: string; | ||
| href?: string; | ||
| } | ||
| export interface ReportPushMetricsRequestData { | ||
| delivery_id: string; | ||
| metric: 'converted' | 'delivered' | 'opened'; | ||
| timestamp?: number; | ||
| recipient?: string; | ||
| } | ||
| export interface ReportSlackMetricsRequestData { | ||
| delivery_id: string; | ||
| metric: 'clicked' | 'converted' | 'delivered' | 'opened'; | ||
| timestamp?: number; | ||
| href?: string; | ||
| } | ||
| export interface ReportSMSMetricsRequestData { | ||
| delivery_id: string; | ||
| metric: 'bounced' | 'clicked' | 'delivered' | 'opened'; | ||
| timestamp?: number; | ||
| recipient?: string; | ||
| reason?: string; | ||
| href?: string; | ||
| } | ||
| export interface ReportWebhookMetricsRequestData { | ||
| delivery_id: string; | ||
| metric: 'bounced' | 'clicked' | 'converted' | 'deferred' | 'delivered' | 'dropped' | 'opened' | 'spammed'; | ||
| timestamp?: number; | ||
| reason?: string; | ||
| href?: string; | ||
| } | ||
| export type ReportMetricsRequestData = | ||
| | ReportEmailMetricsRequestData | ||
| | ReportInappMetricsRequestData | ||
| | ReportPushMetricsRequestData | ||
| | ReportSlackMetricsRequestData | ||
| | ReportSMSMetricsRequestData | ||
| | ReportWebhookMetricsRequestData; |
Collaborator
There was a problem hiding this comment.
Since there's no way to narrow the type here to choose a variant (i.e. there's no way for TS to know if it should be choosing an SMS metrics object over email) I think it would be better to match the docs and have a single request type for now.
This will also prevent issues such as the Push and Slack metrics objects not having reason, etc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a function for reporting metrics
https://docs.customer.io/api/track/#operation/metrics