Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.
JourneyExecutionActivityMetricsResponse is a JSON Structure definition published by Amazon Pinpoint, describing 6 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-journey-execution-activity-metrics-response-structure.json",
"name": "JourneyExecutionActivityMetricsResponse",
"description": "Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.",
"type": "object",
"properties": {
"ActivityType": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "<p>The type of activity that the metric applies to. Possible values are:</p> <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.</p></li> <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.</p></li> <li><p>MESSAGE - For an email activity, which is an activity that sends an email message to participants.</p></li> <li><p>MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.</p></li> <li><p>RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.</p></li> <li><p>WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.</p></li></ul>"
}
]
},
"ApplicationId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier for the application that the metric applies to."
}
]
},
"JourneyActivityId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier for the activity that the metric applies to."
}
]
},
"JourneyId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier for the journey that the metric applies to."
}
]
},
"LastEvaluatedTime": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric."
}
]
},
"Metrics": {
"allOf": [
{
"$ref": "#/components/schemas/MapOf__string"
},
{
"description": "A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the <a href=\"https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html\">Amazon Pinpoint Developer Guide</a>."
}
]
}
},
"required": [
"Metrics",
"JourneyId",
"LastEvaluatedTime",
"JourneyActivityId",
"ActivityType",
"ApplicationId"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.