Table of Contents
Read methods
| Method / Path: | GET /providers/{providerId} |
|---|---|
| Description: | Returns the statistics provider with the specified id |
| Path params: | providerId: The identifier of the statistics provider |
| Optional (query) params: | withparameters: Whether the parameters should be included in the response. |
| Response formats: |
application/json
application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: | 200: OK, Returns the requested statistics provider as JSON |
| Notes: |
|
| Testing: |
Sample:
/providers/{providerId}?withparameters={withparameters}
Testing form (click to reveal)
|
| Method / Path: | GET /providers |
|---|---|
| Description: | Returns a list of available statistics providers |
| Path params: | NONE |
| Optional (query) params: |
filter:
Usage [Filter Name]:[Value to Filter With]. Available filter: "resourceType" withparameters: Whether the parameters should be included in the response. |
| Response formats: |
application/json
application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
200: OK, Returns the requested statistics providers as JSON 401: Unauthorized, If the current user is not authorized to perform this action |
| Notes: |
|
| Testing: |
Sample:
/providers?filter={filter}&withparameters={withparameters}
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST /data/export.csv |
|---|---|
| Description: | Returns a statistics csv export |
| Path params: | NONE |
| Required (form) params: | data: A JSON object describing the query to be executed |
| Optional (form) params: |
limit(Default value=0):
Limit for pagination. offset(Default value=0): Offset for pagination. filter: Usage [Filter Name]:[Value to Filter With]. Multiple filters can be used by combining them with commas ",". |
| Response formats: |
application/json
application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json |
| Status codes: |
200: OK, Returns the csv data as requested by the query as plain text 401: Unauthorized, If the current user is not authorized to perform this action |
| Notes: |
|
| Testing: |
Sample:
/data/export.csv
Testing form (click to reveal)
|
| Method / Path: | POST /data/query |
|---|---|
| Description: | Returns the statistical data based on the query posted |
| Path params: | NONE |
| Required (form) params: | data: An JSON array describing the queries to be executed |
| Optional (form) params: | NONE |
| Response formats: |
application/json
application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
200: OK, Returns the statistical data as requested by the query as JSON array 401: Unauthorized, If the current user is not authorized to perform this action |
| Notes: |
|
| Testing: |
Sample:
/data/query
Testing form (click to reveal)
|