Skip to content

API

Jump to bottom
Ryan Wold edited this page Jan 28, 2021 · 26 revisions

Touchpoints API

Setup: Specify your api.data.gov API key in Touchpoints

To access the Touchpoints API, an api.data.gov API Key is required. If you have an existing api.data.gov API key, enter it on your Touchpoints profile page.

Using the Touchpoints API

The API gateway is: https://api.gsa.gov/analytics/touchpoints/v0/

There are 2 versions of the API:

  1. Version 0 (BETA) - https://api.gsa.gov/analytics/touchpoints/v0/
  2. Version 1 - https://api.gsa.gov/analytics/touchpoints/v1/

Requests through the api.gsa.gov gateway are routed to the Touchpoints app at /api/v0/ and /api/v1/ respectively.

Available API endpoints
  • GET /api/v1/forms
  • GET /api/v1/forms/:id - also returns responses
Example Requests

https://api.gsa.gov/analytics/touchpoints/v0/forms.json

https://api.gsa.gov/analytics/touchpoints/v1/forms.json https://api.gsa.gov/analytics/touchpoints/v1/forms/FORM-SHORT-UUID.json

In production, the API_KEY should be passed using the header X-Api-Key as described here.

For a quick test, try https://api.gsa.gov/analytics/touchpoints/v1/forms.json?API_KEY=YOUR-API-DATA-GOV-KEY

Feedback regarding this API

Please provide feedback at feedback-analytics@gsa.gov, or to the feedback form at https://touchpoints.digital.gov, or https://github.com/gsa/touchpoints/issues/new.

Clone this wiki locally