Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleStorage Report REST Methods

Get Storage Reports by Space

  • Purpose: Returns storage report summaries for a space. Report values are averaged based on the grouping internal (if groupBy=month, all data points within each month are averaged to provide an aggregate result).
  • Request: GET https://host:port/durastore/report/space/{spaceId} ? (storeID) (start) (end) (groupBy)
    • spaceID - ID of the space for which the storage report will be retrieved
    • storeID (optional) - ID of the content storage provider to query (default is primary store)
    • start (optional) - Timestamp in epoch milliseconds which defines the starting point for results. Any data points which are prior to this value are not included.
    • end (optional) - Timestamp in epoch milliseconds which defines the end point for results. Any data points which are after this value are not included.
      • usage note: To ensure that all expected data points are included, set the end timestamp to the very end of the final interval (e.g. 23:59:59 on the last day of the week/month)
    • groupBy (optional) - Grouping interval which allows for averaged results for days, weeks, and months. Valid values are: "day", "week", and "month" (default is day)
  • Response Code: 200 (on success)

  • Response Body: JSON array of storage report details

    Code Block
    titleJSON results
    [
      {"timestamp":1312588800000,"accountId":"<account-id>","spaceId":"<space-id>","storeId":"<store-id>","byteCount":1000,"objectCount":10},
      {"timestamp":1315008000000,"accountId":"<account-id>","spaceId":"<space-id>","storeId":"<store-id>","byteCount":1000,"objectCount":10},
      {"timestamp":1315526400000,"accountId":"<account-id>","spaceId":"<space-id>","storeId":"<store-id>","byteCount":1000,"objectCount":10}
    ]

Get Storage Reports by Store

  • Purpose: Returns storage report summaries for all content in a storage provider. Report values are averaged based on the grouping internal (if groupBy=month, all data points within each month are averaged to provide an aggregate result).
  • Request: GET https://host:port/durastore/report/store ? (storeID) (start) (end) (groupBy)
    • storeID (optional) - ID of the content storage provider to query (default is primary store)
    • start (optional) - Timestamp in epoch milliseconds which defines the starting point for results. Any data points which are prior to this value are not included.
    • end (optional) - Timestamp in epoch milliseconds which defines the end point for results. Any data points which are after this value are not included.
      • usage note: To ensure that all expected data points are included, set the end timestamp to the very end of the final interval (e.g. 23:59:59 on the last day of the week/month)
    • groupBy (optional) - Grouping interval which allows for averaged results for days, weeks, and months. Valid values are: "day", "week", and "month" (default is day)
  • Response Code: 200 (on success)

  • Response Body: JSON array of storage report details

    Code Block
    titleJSON results
    [
      {"timestamp":1312588800000,"accountId":"<account-id>","storeId":"<store-id>","byteCount":1000,"objectCount":10},
      {"timestamp":1315008000000,"accountId":"<account-id>","storeId":"<store-id>","byteCount":1000,"objectCount":10},
      {"timestamp":1315526400000,"accountId":"<account-id>","storeId":"<store-id>","byteCount":1000,"objectCount":10}
    ]

Get Storage Reports for all Spaces in a Store (in a single day)

  • Purpose: Returns storage report summaries for all spaces in a storage provider on a single day.
  • Request: GET https://host:port/durastore/report/store/{date} ? (storeID)
    • date - Timestamp in epoch milliseconds which specifies the requested day
    • storeID (optional) - ID of the content storage provider to query (default is primary store)
  • Response Code: 200 (on success)

  • Response Body: JSON array of storage report details

    Code Block
    titleJSON results
    [
      {"timestamp":1312588800000,"accountId":"<account-id>","spaceId":"<space-id-1>","storeId":"<store-id>","byteCount":1000,"objectCount":10},
      {"timestamp":1315008000000,"accountId":"<account-id>","spaceId":"<space-id-2>","storeId":"<store-id>","byteCount":1000,"objectCount":10},
      {"timestamp":1315526400000,"accountId":"<account-id>","spaceId":"<space-id-3>","storeId":"<store-id>","byteCount":1000,"objectCount":10}
    ]

...