1. Resource Central
  2. arrow-right
  3. Snapshots

Snapshots

Conclusions use report results to group and present Power Pick data as useful and visual information.

Attributes

  • id integer

    Unique identifier for the object

  • name string

    A non-unique name given to the object

  • type string

    Operation to perform on row count. Either count, sum, average, minimum, or maximum

  • reportId integer

    The id of the report the snapshot belongs to

  • groupColumnId integer

    The id of the report column that the snapshot data is grouped by

  • triggerFrequency string

    How frequently the snapshot is performed. Either minute, hour, day, week, month, year

  • lastTriggered datetime

    Datetime of when the snapshot was last triggered

Endpoints

List Snapshots /api/snapshots
get

Get a list of ItemPath report snapshots. View the guide on adding filters to List API calls.

Body Parameters

  • name string

    Search by snapshot name.

  • reportId integer

    Return snapshots belonging to the report.

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 1000.

    Default value:

    250

  • page integer

    Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.

  • countOnly boolean

    When "true", will only return a count of the amount of items in the query.

    Default value:

    false

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/snapshots" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{
 "snapshots": [
  {
   "lastTriggered": "2021-06-02T14:03:13.300872",
   "id": 4,
   "type": "count",
   "reportId": 4,
   "groupColumnId": 8,
   "triggerFrequency": "hour",
   "name": "picks by part"
  }
 ]
}