Skip to content

API

Jump to bottom
Ryan Wold edited this page Apr 26, 2024 · 24 revisions

Touchpoints API

Touchpoints makes customer feedback easier for federal agencies, and Touchpoints API provides a convenient, programmatic way to access the data for your Forms, Responses, and other Customer Experience (CX) related domain objects.

The Touchpoints application provides all API endpoints for registered Touchpoints Federal staff and contractor users, and 2 of those API endpoints (Digital Service Accounts and Digital Products) are also available for public users.

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

To access the Touchpoints API, an api.data.gov API Key is required.

To access staff API's:

If you have an existing api.data.gov API key, enter it on your Touchpoints profile page.

Using the Test/Development Touchpoints API

There are 2 versions of the API:

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

Requests to api.gsa.gov/test/ are routed to touchpoints-staging.app.cloud.gov app at /api/v0/ and /api/v1/ respectively.

Using the Production Touchpoints API

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.

OpenAPI Documentation

API endpoints available for Federal Staff

  • GET /api/v1/forms
  • GET /api/v1/forms/:id - also returns an array of Responses, or "submissions"
  • GET /api/v1/service_providers
  • GET /api/v1/services
  • GET /api/v1/collections
  • GET /api/v1/omb_cx_reporting_collections
  • GET /api/v1/cx_collections
  • GET /api/v1/cx_collection_details
  • GET /api/v1/cx_responses uses ?page[number]=X and page[size]=Y for pagination
  • GET /api/v1/cscrm_data_collections
  • GET /api/v1/websites
  • GET /api/v1/personas
  • GET /api/v1/goals

API endpoints available for public users and Federal Staff

  • GET /api/v1/digital_service_accounts
  • GET /api/v1/digital_products

Query parameters

  • page_size - value can be set between 1 to 500. defaults to 500
  • page - defaults to 1
  • start_date - set in YYYY-MM-DD format. defaults to 1 year ago
  • end_date - set in YYYY-MM-DD format. defaults to tomorrow

Example Requests

For the /v0 api:

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

For the /v1 api:

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/digital_products.json?API_KEY=YOUR-API-DATA-GOV-KEY

Complete OpenAPI documentation is available via https://touchpoints.app.cloud.gov/api/.

Feedback regarding this API

Please provide feedback at:

Clone this wiki locally