List custom metrics
https://email.growthdept.ai/api/custom-metricsRate limits
Scopes
metrics:read
Operation id
get_custom_metrics The same operation as in Klaviyo's API. OpenAPI document
Query parameters
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataarray of objectsrequired
data: 5 fields
typestringrequired
custom-metricidstringrequired
attributesobjectrequired
attributes: 4 fields
namestringrequired
createdstring (date-time)required
updatedstring (date-time)required
definitionobjectrequired
definition: 2 fields
aggregation_methodstringrequired
countvaluemetric_groupsarray of objectsrequired
metric_groups: 3 fields
metric_idstringrequired
metric_filtersarray of objectscan be null
metric_filters: 2 fields
propertystringrequired
filterone ofrequired
One option: NumericOperatorNumericFilter
typestringrequired
numericoperatorstringrequired
equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equalsvalueobjectrequired
One option: StringInArrayFilter
operatorstringrequired
invaluearray of stringsrequired
typestringrequired
string
One option: ExistenceOperatorExistenceFilter
typestringrequired
existenceoperatorstringrequired
is-setnot-set
One option: BooleanFilter
typestringrequired
booleanoperatorstringrequired
equalsvaluebooleanrequired
One option: StringOperatorStringFilter
typestringrequired
stringoperatorstringrequired
containsends-withequalsnot-containsnot-ends-withnot-equalsnot-starts-withnregexregexstarts-withvaluestringrequiredcan be null
One option: ListContainsOperatorListContainsFilter
typestringrequired
listoperatorstringrequired
containsnot-containsvalueobjectrequiredcan be null
One option: ListRegexOperatorListContainsFilter
typestringrequired
listoperatorstringrequired
contains-ends-withcontains-starts-withnot-contains-ends-withnot-contains-starts-withvalueobjectrequiredcan be null
One option: ListSubstringFilter
typestringrequired
listoperatorstringrequired
contains-substringnot-contains-substringvaluestringrequiredcan be null
value_propertystringcan be null
relationshipsobject
relationships: 1 field
metricsobject
metrics: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
metricidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 3 fields
selfstring (uri)required
prevstring (uri)
nextstring (uri)
metaobject
includedarray of objects
included: 5 fields
typestringrequired
metricidstringrequired
attributesobjectrequired
attributes: 4 fields
namestringcan be null
createdstringcan be null
updatedstringcan be null
integrationobjectcan be null
relationshipsobject
relationships: 1 field
flow-triggersobject
flow-triggers: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
flowidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject