Klaviyo · Schema

MappedMetricPartialUpdateQueryResourceObject

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string The type of mapping.
relationships object
View JSON Schema on GitHub

JSON Schema

klaviyo-mappedmetricpartialupdatequeryresourceobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MappedMetricPartialUpdateQueryResourceObject",
  "title": "MappedMetricPartialUpdateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/MappedMetricEnum"
    },
    "id": {
      "description": "The type of mapping.",
      "type": "string",
      "example": "revenue",
      "enum": [
        "added_to_cart",
        "cancelled_sales",
        "ordered_product",
        "refunded_sales",
        "revenue",
        "started_checkout",
        "viewed_product"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/MetricEnum"
                },
                "id": {
                  "description": "The ID of the metric for this mapping. A null value will unset the mapping.",
                  "type": "string"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        },
        "custom-metric": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/CustomMetricEnum"
                },
                "id": {
                  "description": "The ID of the custom metric for this mapping. A null value will unset the mapping.",
                  "type": "string"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        }
      }
    }
  },
  "required": [
    "type",
    "id"
  ]
}