Tasks

Get one task's calculation history by calibration period

Returns immutable task progress observed after each Ranking Sensor calculation, grouped under the calibration that reset and governed that task period.

get/api/v1/tasks/{taskId}/history

Request

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

Path parameters

taskIdinteger required

Query parameters

boostFactorIdinteger

endDatestring

offsetinteger

pageSizeinteger

rankingSensorIdinteger

serverHoststring

snapshotIdinteger

sortBystring

sortDirstring

startDatestring

taskTitlestring

webpageIdinteger

websiteIdinteger

workspaceIdinteger

Response

Task calculation history grouped by calibration period.

taskKeystring

sourceTaskIdinteger

matchStrategy'STABLE_IDENTIFIERS' | 'TITLE_FALLBACK'

currentTaskIdinteger

occurrenceCountinteger

calibrationCountinteger

calculationCountinteger

historyAvailableFromstring date-time

historyCompleteness'FULL' | 'LEGACY_DERIVED' | 'PARTIAL'

firstSeenAtstring date-time

lastSeenAtstring date-time

currentProgressPercentageinteger

offsetinteger

pageSizeinteger

hasMoreboolean

Example response

{
  "historyAvailableFrom": "2022-03-10T16:15:50Z",
  "calibrationPeriods": [
    {
      "calibrationDate": "2022-03-10T16:15:50Z",
      "firstSeenAt": "2022-03-10T16:15:50Z",
      "lastSeenAt": "2022-03-10T16:15:50Z",
      "calculations": [
        {
          "snapshotDate": "2022-03-10T16:15:50Z"
        }
      ]
    }
  ],
  "firstSeenAt": "2022-03-10T16:15:50Z",
  "lastSeenAt": "2022-03-10T16:15:50Z",
  "occurrences": [
    {
      "snapshotDate": "2022-03-10T16:15:50Z"
    }
  ]
}

Changes

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