GSA API
General Services Administration API
Currently it is exclusively used for Search.gov Click Tracking API
Overview and Terminology
The click tracking API endpoint lets you send in click events, which allows you to see click data on your Admin Click Analytics page. We also use this click data to strengthen the search results algorithm for your site. Read more about click tracking here. This API uses the post method for click tracking.
Integration Endpoints
https://api.gsa.gov/technology/searchgov/v2/clicks/
Required Configuration
The required parameters are: url: variable query: variable affiliate: va position: variable module_code: I14Y. access_key: (this is a secret, reach out to me for it) client_ip: variable user_agent: variable
Known External Dependencies
N/A
Troubleshooting
Contact search@support.digitalgov.gov
Expected Results: ● Success - A response status code of 200 and empty body. ● Missing Required Parameters - A response status code of 400 and an error message describing the missing parameters. ["Query can't be blank"] ● Invalid Or Inactive Search Site Handle - A response status code of 401 and an error message. ["Affiliate is invalid"] ● Invalid API Access Key - A response status code of 401 and an error message. ["Access key is invalid"] ● Unparseable URL - A response status code of 401 and an error message. ["Url is not a valid format"] ● Invalid Module Code - A response status code of 401 and an error message. ["Module code {MODULE} is not a valid module"]
Outage Status and Maintenance Windows
None documented
Service Level Agreement
No documented SLA
Escalation Procedure / What to do if the service goes down
Contact Search and Discovery team #va-search slack, contact the support email address below or use the support phone line here: 202-969-7426
Health check endpoint
None currently - will follow up
Contacts
Role | Name | |
|---|---|---|
Support | N/A |
Help and feedback
Get help from the Platform Support Team in Slack.
Submit a feature idea to the Platform.