Amazon Pinpoint · Schema

ResultRowValue

Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
Key object
Type object
Value object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-result-row-value-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-result-row-value-schema.json",
  "title": "ResultRowValue",
  "description": "Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.",
  "type": "object",
  "properties": {
    "Key": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The friendly name of the metric whose value is specified by the Value property."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The data type of the value specified by the Value property."
        }
      ]
    },
    "Value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects)."
        }
      ]
    }
  },
  "required": [
    "Type",
    "Value",
    "Key"
  ]
}