Please enable JavaScript to view this site.

Navigation: Reporting

Pinpoint Reporting API

Prev Top Next More

Pinpoint provides an API endpoint for pulling data into other reporting platforms. As with the Reporting site, the Swagger page for the API site can be reached here (URL differs by environment):

https://reporting-api.dev.pinpoint811.VertiGIS.com/index.html

reporting-api-swagger-site

  Swagger page for the Reporting API site

 

While there are many free tools available that allow easy interaction with HTTP-based APIs, VertiGIS recommends Postman. You can download it here. Postman allows you to easily create, save, and organize calls to API methods.

 

To set up Postman:

1.Import the collection of API methods into Postman by using the highlighted URL (swagger.json). Right-click the link and choose Copy link address.

 
reporting-copy-url-to-clipboard

Copy the API URL to the clipboard

2.Click Import.
reporting-postman-application-click-import-button

Postman application - click the Import button

3.Click Link and paste the copied URL from step 1 above:
reporting-postman-application-enter-link-url

Postman application - enter link URL

4.Under Collections, choose an API method.
reporting-postman-application-collections-choose-api-method

Postman application > Collections - choose API method

 

5.For Auth, choose OAuth 2.0. Then click Get New Access Token.
reporting-postman-application-chosen-method-choose-authorization-type

Postman application > chosen method - choose authorization type

6.You are provided an Access Token URL, Client ID, and Client Secret necessary to generate a token (redacted secrets). Click Request Token to continue.
reporting-postman-application-info-for-new-acess-token

Postman application - information for new access token

 

7.Upon requesting a token, you will see this screen if successful (redacted token). Click Use Token.
reporting-postman-application-manage-access-tokens-window

Postman application - Manage Access Tokens window

8.Fill out the date parameters and click Send:

reporting-postman-application-date-parameters-filled

If successful, you should see data returned in JSON format:reporting-postman-application-json-data-returned-example

Example of data returned in JSON format

 

© 2024 VertiGIS North America Ltd. All Rights Reserved. VertiGIS North America Ltd. All Rights Reserved. | Privacy Center | Imprint
Documentation Version 1.1