Mission Control API: Usage report

Using the API is an alternative way to configure and use your Mission Control account. This can be useful if you are interested in writing programs to explore and automate the use of our features.

In this guide we will give you an example of using our API docs GUI. Hopefully this will give you a base for writing programs to interact with our API.

Before we begin, we must tell the API our credentials so the API knows which portal account we will be using it with(and who we are).

For how to do this, please refer to our article on "Authentication and Tokens" after updating your credentials you can follow on from here.

In this article you will learn how to:

  • Get your usage reports
  • Create a usage report
  • Delete a usage report
  • Get a usage report

Get your usage reports

This returns all usage reports that the user has access to, to do this you must specify the page number of results to display per page under parameters and hit the "TRY IT OUT" button, for this example i chose to do 1 result per page. Please see screen print of request and response below:

Parameters

Response

Create a usage report

This generates a usage report based on the start and end times, the particular connection and the aggregate, 0 for all and 1 for connection. To do this, double click in the sample body and the contents will be copied to the parameters section where you can edit as required, then click the TRY IT OUT " button. The start and end times are the minimum parameters, every other is optional. Please see screen print of request and response below:

Parameters

Response

*Please not that usage Reports are available for 30 days

Delete a usage report

This action deletes a usage report based on the usage report id provided. To do this simply input the usage report id and click on the "TRY IT OUT" button. Please find below a screen print of the request and response respectively:

Parameters

Response

Get a usage report

This returns the status of a single usage report by supplying the usage report id. Response includes a link to the report once it is generated. Please find screen print of request and response respectively:

Parameters

Response

Congratulations! that's all there is to reporting.


Can't find what you're looking for? Click the chat bubble at your lower right-hand corner and start a chat!

Did this answer your question?