Throughput

API to be used by the clients to submit task completed info which is used to capture task attributes of completed unit of work across different workstreams.

Throughput API

API to be used by the clients to submit task completed info which is used to capture task attributes of completed unit of work across different workstreams.

POSThttps://api.cloudfactory.app/v1/workstreams/{workstream_id}/task_completed

Path parameters

workstream_id*string

CloudFactory platform WorkStream ID

Header parameters

Body

application/json

Task parameters object

worker_id*string

Email address or any other identifier of the worker who completed the task

Example: "[e-mail]"

task_idstring

ID of task that was completed

Example: "032d6802-0efa-46de-a73c-6c24f094dfcf"

task_urlstring

URL of the completed task

Example: "https://taskus.com/annotate/123412"

task_countnumber

The total number of tasks that were completed. The default is one, to signify that each API call represents a single task.

Example: 10

subtask_countnumber

The total number of subtasks that were completed. The default is null.

Example: 10

use_case_id*string

The ID of the Use Case to which the task belongs. It is validated against the WorkStream configuration

Example: "305ea07b-1d24-4f8f-8e1d-aae27cb07840"

task_definition_id*string

The ID of the Task Definition to which the task belongs. It is validated against the WorkStream configuration.

Example: "4ed59e6b-bf4b-4f33-a1dc-4015d63eef59"

task_started_at*string (date-time)

Timestamp (in ISO 8601 datetime format) for when the task was started.

Example: "2020-12-22T09:13:24.127Z"

task_completed_at*string (date-time)

Timestamp (in ISO 8601 datetime format) for when the task was completed.

Example: "2020-12-22T10:13:24.127Z"

durationnumber

The time taken to complete the task (in seconds). If this is not provided, then it is calculated automatically as 'task_completed_at' minus 'task_started_at'.

Example: 3600

task_created_atstring (date-time)

The task created timestamp in ISO 8601 datetime format

Example: "2020-12-22T10:13:24.127Z"

task_measurementsobject

This can be used to provide up to three different measures for the amount of work completed.

data_sourcestring

This can be used to specify how the data was sourced. If it is provided, then the 'data_source' must be one of 'api', 'csv_manual' or 'csv_automated'.

Example: "api"

task_metadataobject

These are key-value pairs used to define the task.

dataset_idstring

ID of the dataset which the task belongs to

Example: "6c24f094dfcf"

asset_idstring

ID of the parent asset which the task belongs to

Example: "6c24f094dfcf"

unique_idstring

Any unique identifier that if sent will be checked for uniqueness in the system for any given WorkStream, use case and task definition

Example: "032d6802-0efa-46de-a73c-6c24f094dfcf"

replace_duplicateboolean

When true, it replaces the old values with the new ones. If false, it will simply ignore the duplicate API call

Example: true

Response

202400403500

Successful

Body

application/json

messagestring

Example: "Data successfully received."

Request

JavaScriptCurlPython

const response = await fetch('https://api.cloudfactory.app/v1/workstreams/{workstream_id}/task_completed', {
    method: 'POST',
    headers: {
      "x-api-key": "loAwlMCCxv4TlpLWR8a2e6",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "worker_id": "[e-mail]",
      "task_completed_at": "2020-12-22T10:13:24.127Z",
      "task_started_at": "2020-12-22T09:13:24.127Z",
      "use_case_id": "305ea07b-1d24-4f8f-8e1d-aae27cb07840",
      "task_definition_id": "4ed59e6b-bf4b-4f33-a1dc-4015d63eef59"
    }),
});
const data = await response.json();

Response

202400403500

{
  "message": "Data successfully received."
}