GET /workflows/runs/{id}¶
Use the /workflows/runs/{id} endpoint to return details for a specific workflow.
Available HTTP methods¶
![GET /workflows/runs/{id}](_images/api-request-get-workflow-runs-fetch.png)
Prerequisites¶
Base URL¶
All requests made to the /workflows/runs/{id} endpoint should be directed to the following base URL:
https://{tenant-id}.amperity.com/api/workflows/runs/{id}
Rate limit¶
A rate limit is the number of requests that may be made to the Amperity API in a given time period.
The Amperity API supports requests to endpoints that do not exceed a rate of 10 requests per second. Response times will vary by endpoint and the complexity of data that is returned by the response. Some requests may take seconds to return.
Requests to the Amperity API that exceed 10 requests per second may return an error response with an HTTP 429 status code.
Requests¶
A request to the /workflows/runs/{id} endpoint is similar to:
curl --request GET \
'https://tenant.amperity.com/api/workflows/runs/{id} \
?view=overview \
--header 'amperity-tenant: tenant' \
--header 'api-version: 2024-04-01' \
--header 'Authorization: Bearer token'
(This example is formatted for readability in a narrow page layout.)
Request parameters¶
The following table describes the parameters that may be used with the /workflows/runs/{id} endpoint.
Parameter |
Description |
---|---|
api_version |
String. Optional. A supported version of the Amperity API. For example: 2024-04-01. Note You may use the api-version request header instead of the api_version request parameter. |
{id} |
String. Required. The unique identifier for a workflow, similar to: wf-20240603-12345-MNabc. The workflow ID must be in the URL. For example: /workflows/runs/wf-20240603-12345-MNabc. Use the /workflow/runs endpoint to get a list of workflow IDs or copy the ID from the Workflows page in Amperity. |
view |
String. Optional. Set this value to overview to return only the following parameters: created_at, ended_at, id, name, state, tenant, and type. Set this value to verbose to return all response parameters for the workflow, including for any tasks that were started by the workflow. Default value: overview. |
Request examples¶
The following examples show how to send requests to the /workflows/runs/{id} endpoint.
cURL¶
The following example shows how to use cURL to send a request to the /workflows/runs/{id} endpoint.
curl --request GET \
'https://tenant.amperity.com/api/workflows/runs/{id} \
?view=overview \
--header 'amperity-tenant: tenant' \
--header 'api-version: 2024-04-01' \
--header 'Authorization: Bearer token'
(This example is formatted for readability in a narrow page layout.)
Responses¶
A response from the /workflows/runs/{id} endpoint will match an HTTP status code. A 200 response will contain the results set. A 4xx response indicates an issue with the configuration of your request. A 5xx response indicates that the endpoint is unavailable.
200 OK¶
The 200 response returns details for the named workflow.
Overview
{
"type": "campaign.fetch",
"ended_at": "2024-01-22T18:02:50.769Z",
"id": "wf-20240603-12345-MNabc",
"tenant": "socktown",
"created_at": "2024-01-22T17:57:36.371Z",
"name": "Send audiences to Braze",
"state": "succeeded"
}
Verbose
Important
The list of response parameters that are returned in the response will vary, depending on the state of the workflow, the number of tasks that were initiated by the workflow, and if an error occurred.
{
"task_instances": [],
"error": {
"attribution": "customer",
"type": "amperity.workflow.workflow.repository.core/cancel",
"message": "Workflow manually stopped"
},
"id": "wf-20240603-12345-MNabc",
"ended_at": "2024-02-10T17:29:32.687Z",
"name": "Braze",
"principal_name": "Justin Scott",
"principal_id": "google-apps|justin.scott@socktown.com",
"type": "amperity.orchestration.orchestration/run",
"launched_version": "etv-20240210-12345-6AbCDE",
"principal_email": "justin.scott@socktown.com",
"state": "canceled",
"created_at": "2024-02-10T17:29:22.454Z",
"tenant": "socktown",
"current_version": "etv-20240210-12345-6AbCDE"
}
Response parameters¶
A 200 OK response contains the following parameters.
Parameter |
Description |
---|---|
created_at |
The date and time at which a workflow started. Note The amount of time that elapsed between created_at and ended_at is the runtime for the workflow. The length of time a workflow ran is visible from the Runtime box visible from the Type box on each individual workflow page. |
current_version |
A unique identifier that describes the configuration state of Amperity at the end of the workflow or at the time an error occurred. The value for this property is similar to: “etv-20240210-12345-6AbCDE”. |
ended_at |
The date and time at which a workflow ended. Note The amount of time that elapsed between created_at and ended_at is the runtime for the workflow. The length of time a workflow ran is visible from the Runtime box visible from the Type box on each individual workflow page. |
error |
A JSON array of values for a workflow error. Note An error message is shown for any workflow with a state of Failed. You can view the error message the from the Workflows page. The JSON array for an error is similar to: "error": {
"attribution": "customer",
"type": "amperity.workflow.task.stitch/table",
"message": "Found table in an invalid state:\n
loyalty_members. This error can be\n
resolved by removing this table\n
or by loading data to the table.",
"data": NULL,
},
where:
|
launched_version |
A unique identifier that describes the configuration state of Amperity at the start of the workflow. The value for this property is similar to: “etv-20240210-12345-6AbCDE”. |
name |
The name of the workflow. Note This is the same value that is visible from the title of each individual workflow page and from the Name column on the Workflows page. |
principal_email |
The email address for the user who started the workflow. |
principal_id |
A unique identifier for the Amperity user who started the workflow. For example: “google-apps|socktown@socktown.com”. |
principal_name |
The name of the Amperity user who started the workflow. For example: “Justin Scott” or “Automated workflow”. |
state |
The current state of the workflow. For example:
Note This is the same value that is visible from the Status box on each individual workflow page and from the Status column on the Workflows page. |
task_instances |
A JSON array that contains zero (or more) sets of the following parameters, one set for each task in the workflow. The list of parameters returned in the response may vary, depending on the type of task.
Note This is the same value that is visible from the Task column on each individual workflow page.
|
tenant |
The unique identifier for the tenant. |
type |
The type of workflow. Most workflows will have workflow types related to the following areas within Amperity:
Note This is the same value that is visible from the Type box on each individual workflow page and from the Type column on the Workflows page. |
warn_after_ms |
The length of time (in milliseconds) after which a warning is sent that notifies users that a workflow is running longer than expected. Note This parameter only applies to workflows that use SQL to write tables to storage. |
workflow_id |
The unique identifier for the workflow. Note This is the same value as the Definition ID field in the Task Details dialog, which can be opened from the actions menu ( ) for each task in the workflow. |