Client jobs

List Client Jobs

Get client jobs for the current project.

GET
/nudge/projects/{projectId}/jobs/

Authorization

clientKeyHeader clientSecretHeader
x-client-key<token>

Client API key credential.

In: header

x-client-secret<token>

Client API secret credential.

In: header

Path Parameters

projectId*string

Query Parameters

status?array<>|
jobType?array<>|
jobCategory?string
Value in"target_list" | "cohort" | "customer_pool"
timeRange?string
Match^(24h|7d|30d|all)$
entityId?array<string>|string
searchJobs?string
page*string
Default"1"
Match^[0-9]+$
size*string
Default"25"
Match^[0-9]+$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.dokaai.com/api/v1/dokaai/nudge/projects/string/jobs/?page=1&size=25"
{
  "status": "success",
  "message": "string",
  "data": [
    {
      "id": "string",
      "jobCategory": "string",
      "jobCategoryName": "string",
      "initiatedBy": "string",
      "jobType": "string",
      "latestRunTime": "string",
      "mediaManagerId": "string",
      "failedRowsCount": 0,
      "inputCustomerCount": 0,
      "status": "pending"
    }
  ],
  "metaData": {
    "page": 0,
    "hasMore": true,
    "pageSize": 0,
    "count": 0
  },
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}