latestSwagger 2.0Apache 2.02026-08-0824630.2 KB

4f44976989c8

CaptureHistory

Get history for a scheduled capture, page by page

get/capturehistory/{scheduledCaptureId}

Path parameters

scheduledCaptureIdstring uuid required

Query parameters

pageIndexinteger

Get history for a page number

pageSizeinteger

Number of items per page

startDatestring

Get history from a specific date: year-month-day hour:minute:second.millisecond (example: 2020-04-25 07:00:00.000)

endDatestring

Get history up to a specific date: year-month-day hour:minute:second.millisecond (example: 2020-05-25 06:59:59.999)

Response

successful operation

pageCountinteger

Number of pages that can be retrieved

pageIndexinteger

Current page number

Example response

{
  "pageCount": 7,
  "history": [
    {
      "id": "204347e0-eaf8-11e9-ac83-338a9cee6792",
      "createdAt": "2019-10-09T02:43:15.281Z",
      "updatedAt": "2019-10-09T02:43:15.281Z",
      "scheduledCapture": {
        "id": "204347e0-eaf8-11e9-ac83-338a9cee6792",
        "name": "My capture",
        "createdAt": "2019-10-09T02:43:15.281Z",
        "updatedAt": "2019-10-09T02:43:15.281Z",
        "captureRequest": {
          "apps": [
            "204347e0-eaf8-11e9-ac83-338a9cee6792"
          ],
          "browser": "Chrome",
          "country": "USA",
          "emails": [
            "foo@gmail.com"
          ],
          "format": "png",
          "height": 1024,
          "size": "Full Page",
          "steps": [
            {
              "command": "type",
              "selector": "#login-btn",
              "value": "username"
            }
          ],
          "waitSecond": 5,
          "maxWait": 10,
          "hidePopups": 1,
          "dark": 1,
          "strictSSL": 1,
          "width": 1280,
          "zoom": 100
        },
        "schedule": {
          "exactDates": [
            "2020-05-15"
          ],
          "timesOfDay": [
            "17:05"
          ]
        },
        "trackers": [
          {
            "id": "amazon_category_rank",
            "input": "B0BFYM54RF"
          }
        ]
      },
      "fileId": "204347e0-eaf8-11e9-ac83-338a9cee6792",
      "thumbnailFileId_236": "204347e0-eaf8-11e9-ac83-338a9cee6792"
    }
  ],
  "details": {
    "apps": [
      {
        "id": "204347e0-eaf8-11e9-ac83-338a9cee6792"
      }
    ]
  },
  "trackers": [
    {
      "name": "Best Sellers in Waist Trimmers",
      "shot": "1",
      "found": 1,
      "value": "12"
    }
  ]
}