URI HTTP methods Schemas Properties See also

Journey Runs

A journey is an automated workflow that performs a series of messaging activities for an Amazon Pinpoint application. A journey run represents each scheduled entry of endpoints into the journey. The journey run resource provides information about each journey run, including timing information and status.

Each journey run represents a single evaluation of a segment, so can include endpoints in different timezones. These endpoints may actually enter the journey at different times, depending on their timezones, but each are represented by the same journey run.

URI

/v1/apps/application-id/journeys/journey-id/runs

HTTP methods

GET

Operation ID: GetJourneyRuns

Provides information about the runs of a journey.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
`journey-id`	String	True	The unique identifier for the journey.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Query parameters
Name	Type	Required	Description
`page-size`	String	False	The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
`token`	String	False	The `NextToken` string that specifies which page of results to return in a paginated response.

Responses
Status code	Response model	Description
`200`	`JourneyRunsResponse`	The request succeeded.
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the Journey Run resource.

Path parameters
Name	Type	Required	Description
`journey-id`	String	True	The unique identifier for the journey.
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Responses
Status code	Response model	Description
`200`	None	The request succeeded.

Schemas

Response bodies


{
  "NextToken": "string",
  "Item": [
    {
      "RunId": "string",
      "CreationTime": "string",
      "LastUpdateTime": "string",
      "Status": enum
    }
  ]
}


{
  "RequestID": "string",
  "Message": "string"
}

Properties

JourneyRunResponse

Provides information from a specified run of a journey.

Property	Type	Required	Description
`CreationTime`	string	True	The time when the journey run was created or scheduled, in ISO 8601 format.
`LastUpdateTime`	string	True	The last time the journey run was updated, in ISO 8601 format..
`RunId`	string	True	The unique identifier for the run.
`Status`	string Values: `SCHEDULED \| RUNNING \| COMPLETED \| CANCELLED`	True	The current status of the run.

JourneyRunsResponse

Provides information from all runs of a journey.

Property	Type	Required	Description
`Item`	Array of type JourneyRunResponse	True	An array of responses, one for each run of the journey
`NextToken`	string	False	The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

MessageBody

Provides information about an API request or response.

Property	Type	Required	Description
`Message`	string	False	The message that's returned from the API.
`RequestID`	string	False	The unique identifier for the request or response.