Tasks

Get an individual Ranking Sensor task

Returns one current or archived task when it is visible to the authenticated customer.

get/api/v1/tasks/{taskId}

Request

  • Base URL: https://brew.marketbrew.ai/api/v1
  • URL: https://brew.marketbrew.ai/api/v1/api/v1/tasks/{taskId}
  • Auth: API key in header API-Key

Path parameters

taskIdinteger required

Response

The requested individual task.

taskIdinteger
taskKeystring
parentTaskIdinteger
taskTitlestring
summarystring
descriptionstring
taskTypeinteger
taskTypeLabelstring
optimizationScorenumber
hoursRequirednumber
previousCompletionPercentageinteger
completionPercentageinteger
progressDeltainteger
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED'
childCountinteger
archivedboolean
snapshotIdinteger
snapshotDatestring date-time
rankingSensorIdinteger
rankingSensorNamestring
correlationKeywordstring
websiteIdinteger
webpageIdinteger
boostFactorIdinteger
serverHoststring
pagePathstring

Example response

{
  "snapshotDate": "2022-03-10T16:15:50Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.