API Introduction - Integrate SWOOP with other data

The SWOOP API enables you to request the calculated SWOOP values for all reports on all dashboards. There are also several export options available.

You will need an authorization token to use the API.  Follow these steps to get started:

1. Read the API documentation

For security reasons the API documentation is not publicly available, but once you have logged into SWOOP you can access it by clicking Admin Settings / API Token, and then click the link to open the documentation:

Tip: You can also just add "v1/api/doc" at the end of the SWOOP site URL and you will get to the documentation, for example https://yoursitename.swoopanalytics.com/v1/api/doc.

2. Generate a token

To generate a token you need to complete the following fields in the form:

• 'Expires in' to set the expiration date of the token. The maximum duration is 1 year. For security reasons, this should not be set longer than necessary.
• 'Admin' determines if the token has the same permissions as a SWOOP admin. It is not ticked then the token will have the same permission as a normal user.
• 'Token notes' is used for you to document what you will use the token for.

Once you have generated the token remember to temporarily store it somewhere as it will be removed from the screen once you click 'Save'.

3. Extract data

Use the token and the documentation to extract the data you want.

See also Using Azure API Management service to restrict access to the SWOOP API.