AMamz-racing
basic

List bags in store

get/stores/{store_name}/bags

Request

Path parameters

store_namestring required

Name of the store

Query parameters

limitinteger
offsetinteger
orderingstring
discovered_gtestring date-time
discovered_ltestring date-time
start_time_gtestring date-time
start_time_ltestring date-time
end_time_gtestring date-time
end_time_ltestring date-time
duration_gtenumber
duration_ltenumber
meta_availableboolean
is_extractedboolean
namestring
tagsstring
in_trashboolean

Response

Returns a list of bags

detail_typestring required
namestring required
store_dataobject required

Data that is specific to the bag store type.

discoveredstring date-time required

Date and time this bag was discovered.

extraction_failureboolean

True if the extraction failed

in_trashboolean

True if the bag is in the trash bin.

is_extractedboolean required

True if data is extracted from this bag.

meta_availableboolean required

True if meta data is known for this bag.

sizeinteger

Size of the bag in bytes.

start_timestring date-time

Start time of this bag.

end_timestring date-time

Start time of this bag.

durationnumber

duration of this bag in seconds.

messagesinteger

Number of messages in this bag.

Example response

[
  {
    "discovered": "2000-01-23T04:56:07.000+00:00",
    "in_trash": true,
    "store_data": "{}",
    "detail_type": "BagSummary",
    "meta_available": true,
    "end_time": "2000-01-23T04:56:07.000+00:00",
    "is_extracted": true,
    "tags": [
      {
        "color": "#FF0000",
        "tag": "good"
      },
      {
        "color": "#FF0000",
        "tag": "good"
      }
    ],
    "duration": 6.027456183070403,
    "start_time": "2000-01-23T04:56:07.000+00:00",
    "size": 0,
    "name": "test-2017-11-11.bag",
    "messages": 1,
    "extraction_failure": true
  }
]

Changes

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