Partner Usage History List

Partner Usage History List

URI

/v1/partners/{username}/usage_history

URI Parameters

  • username (string)

Methods

GET

GET /v1/partners/{username}/usage_history

Gets a partner's usage history

Scope

partners_read

Query Selector Parameters

  • start_date (date)

  • end_date (date)

  • resolution (string const) – DAY|WEEK|MONTH|CUSTOM

  • custom (int) – number of days between dates (min 1, max 60, default 1)

Query Pagination Parameters

  • page (int) – the page number to show (min 1, default 1)

  • page_size (int) – the number of actions per page (min 1, max 90, default varies: 30 DAY, 26 WEEK, 12 MONTH, 30 CUSTOM)

Query Sorting Parameters

  • order_by (string const) – DATE

  • order_dir (string const) – ASC|DESC

Request Body Parameters

  • n/a

Response Attributes

  • date (date)

  • bytes (int) – number of bytes stored

Example JSON

Request:

GET /v1/partner/barracuda/usage_history HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

 

Response:

HTTP/1.1 200 OK

Content-Type: application/json

 

{

  "page": 1,

  "page_size": 10,

  "count": 100,

  "links": [

   {

     "rel": "first",

     "href": "https://api.intronis.com/v1/partners/barracuda/usage_history?page=1"

   },

   {

     "rel": "next",

     "href": "https://api.intronis.com/v1/partners/barracuda/usage_history?page=2"

   }

  ],

  "list": [

   {

     "date": "2011-01-01T00:00:00-05:00",

     "bytes": 4368709120

    },

   {

     "date": "2011-01-02T00:00:00-05:00",

     "bytes": 5368709120

   }

  ]

}

Example XML

Request:

GET /v1/partners/barracuda/usage_history HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

 

Response:

HTTP/1.1 200 OK

Content-Type: application/xml

 

<?xml version="1.0" encoding="UTF-8"?>

<list page="1" page_size="10" count="100">

  <link rel="first" href="https://api.intronis.com/v1/partners/barracuda/usage_history?page=1"/>

  <link rel="next" href="https://api.intronis.com/v1/partners/barracuda/usage_history?page=2"/>

  <usage>

   <date>2011-01-01T00:00:00-05:00</date>

   <bytes>4368709120</bytes>

  </usage>

  <usage>

   <date>2011-01-02T00:00:00-05:00</date>

   <bytes>5368709120</bytes>

  </usage>

</list>


We value your feedback.
If you have questions, suggestions, or feedback on our documentation, contact the Campus Product Documentation team.
For general product inquiries or technical support, please contact the global Barracuda Support team.