Skip to main content
POST
/
workflows
/
runs
/
getData
Query Workflow Runs
curl --request POST \
  --url https://api.emberqa.com/api/workflows/runs/getData \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "limit": 50,
  "filters": {
    "startTime": "2024-01-01T00:00:00Z",
    "endTime": "2024-12-31T23:59:59Z",
    "status": "completed",
    "extraction_template_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "metadata_filters": [
    {
      "metadata_name": "priority",
      "operator": "=",
      "value": "high"
    }
  ]
}
'
{
  "statusCode": "SUCCESS",
  "statusMessage": "Successfully retrieved workflow runs",
  "docs": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "filename": "insurance-verification",
      "status": "completed",
      "created_time": "2024-01-15T10:30:00Z",
      "output_schema": {}
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalCount": 243,
    "limit": 50
  }
}

​
Filtering Options

​
Status Values

  • pending - Queued for processing
  • processing - Currently being processed
  • completed - Successfully completed
  • failed - Processing failed

​
Metadata Filters

Search by custom metadata fields you provided during submission. Supported operators: =, !=, >, <, >=, <=

Authorizations

​
Authorization
string
header
required

API key obtained from the EmberQA dashboard under the "Integrations" tab

Body

application/json
​
page
integer
default:1

Page number for pagination (default: 1)

Example:

1

​
limit
integer
default:50

Results per page (default: 50, max: 100)

Required range: x <= 100
Example:

50

​
filters
object
​
metadata_filters
object[]

Array of metadata field filters based on custom metadata provided during submission

Response

Successfully retrieved workflow runs

​
statusCode
string
Example:

"SUCCESS"

​
statusMessage
string
Example:

"Successfully retrieved workflow runs"

​
docs
object[]
​
pagination
object