Returns a list of workflow executions

Returns a list of workflow executions. Gets status information about the requested workflow execution. Information includes the time windows of data on which the workflow is executing and the S3 path of the workflow output. Workflow executions are asynchronous invocations of a given reporting workflow, used for testing, development, and on-off reporting use-cases.

请求参数

Query 参数

minCreationTime

string

必需

maxCreationTime

string

必需

timeZone

string

必需

workflowId

string

必需

示例值:

my-first-workflow

includeWorkflow

string

必需

示例值:

false

Header 参数

Amazon-Advertising-API-ClientId

string

必需

(Required) The identifier of a client associated with an Amazon Developer account.

示例值:

Amazon-Advertising-API-MarketplaceId

string

必需

(Required) The marketplace identifier for the marketplace in the request. Marketplaces are tied to the country.

示例值:

Amazon-Advertising-API-AdvertiserId

string

必需

(Required) The AMC account identifier. Your Amazon Ads account executive would have provided you this identifier when you onboarded AMC. Alternatively, access the AMC console with your user identifier and password, and grab the entity identifier value that is displayed in the URL. The alphanumeric code that is prefixed with ENTITY is your account identifier. An example of an entity identifier is: ENTITY1AA1AA11AAA1.

示例值:

Authorization

string

必需

示例值:

Bearer {{access_token}}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200Returns a list of workflow executions

application/json

Body

executions

array [object {24}]

必需

availableTimeBeforeWindowSecs

integer

可选

createTime

string

可选

dataGaps

array

可选

disableAggregationControls

boolean

可选

executionCategory

string

可选

executionTime

integer

可选

expireTime

string

可选

ignoreDataGaps

boolean

可选

invalidationOffsetSecs

integer

可选

lastUpdatedTime

string

可选

outputColumns

array [object {3}]

可选

outputS3URI

string

可选

parameterValues

object

可选

status

string

可选

timeWindowEnd

string

可选

timeWindowEndOriginal

string

可选

timeWindowStart

string

可选

timeWindowStartOriginal

string

可选

timeWindowTimeZoneOriginal

string

可选

validatedTime

string

可选

waitUntil

string

可选

workflowExecutionId

string

可选

workflowExecutionTimeoutSeconds

integer

可选

workflowId

string

可选

示例

{
  "executions": [
    {
      "availableTimeBeforeWindowSecs": 0,
      "createTime": "2024-09-25T03:11:52Z",
      "dataGaps": [],
      "disableAggregationControls": false,
      "executionCategory": "AD_HOC",
      "executionTime": 55,
      "expireTime": "2024-09-26T03:11:52Z",
      "ignoreDataGaps": false,
      "invalidationOffsetSecs": 266400,
      "lastUpdatedTime": "2024-09-25T03:14:42Z",
      "outputColumns": [
        {
          "columnType": "DIMENSION",
          "dataType": "STRING",
          "name": "advertiser"
        },
        {
          "columnType": "DIMENSION",
          "dataType": "STRING",
          "name": "campaign"
        },
        {
          "columnType": "METRIC",
          "dataType": "DOUBLE",
          "name": "spend"
        },
        {
          "columnType": "METRIC",
          "dataType": "LONG",
          "name": "impressions"
        },
        {
          "columnType": "DIMENSION",
          "dataType": "LONG",
          "name": "reach"
        }
      ],
      "outputS3URI": "N/A",
      "parameterValues": {},
      "status": "SUCCEEDED",
      "timeWindowEnd": "2024-01-25T05:00:00Z",
      "timeWindowEndOriginal": "2024-01-25T00:00:00",
      "timeWindowStart": "2024-01-20T05:00:00Z",
      "timeWindowStartOriginal": "2024-01-20T00:00:00",
      "timeWindowTimeZoneOriginal": "America/New_York",
      "validatedTime": "2024-09-25T03:11:54.792Z",
      "waitUntil": "2024-09-25T02:11:52Z",
      "workflowExecutionId": "b3a77999-7c8e-4289-9bf9-5da8f178536c",
      "workflowExecutionTimeoutSeconds": 21600,
      "workflowId": "my-first-workflow"
    }
  ]
}