This guide will help you configure and utilize Team GPS Open APIs, allowing third-party applications to extract and use your Team GPS data. The article covers the following topics:
TABLE OF CONTENTS
- Authentication
- API Base Address
- Endpoints
- Parameters
- Response Examples
- Pagination
- Error Codes and Handling
- Integration Examples
Authentication
To access the Team GPS API, you need an API key. Follow these steps to generate your key:
- Log in as an Admin or Integrations Admin user: Ensure you have the appropriate permissions to access API settings.
- Navigate to:
Admin Settings > Integrations > Public APIs.
- Enable Public APIs by toggling the Enable option.
- A confirmation message will appear; click Yes to activate.
- A confirmation message will appear; click Yes to activate.
- Click the Generate Key button.
- Name your key.
- Best Practice: Name the key after the tool with which you’re integrating (e.g., "Power BI Integration").
- Best Practice: Name the key after the tool with which you’re integrating (e.g., "Power BI Integration").
- Copy the generated key immediately.
Note: This is a secret key and will only be shown once for security reasons. If you lose it, you will need to generate a new key.
Using the Key in Requests:
Add the key to the Authorization header of your API request. For example:
Header Key: Authorization
Header Value: YOUR_API_KEY_HERE
API Base Address
Use the following base URL for all API requests:
PRODUCTION: https://api.teamgps.com/
Endpoints
The Team GPS API provides multiple endpoints to interact with your data. Key endpoints include:
- CSAT Reviews:
/v1/csat-reviews - Tickets:
/v1/tickets - Scorecards:
/v1/scorecards - Users:
/v1/users
Parameters
Use query parameters to customize your requests.
Example: CSAT Reviews
Base URL: https://api.teamgps.com/v1/csat-reviews
| Parameter | Type | Description | Default Value |
|---|---|---|---|
page | string | The page number to fetch. | 1 |
page_size | string | The number of reviews per page. | 10 |
from_submitted_date | string | Start date filter (format: YYYY-MM-DD). | - |
to_submitted_date | string | End date filter (format: YYYY-MM-DD). | - |
Response Examples
200 OK Response for CSAT Reviews:
{
"results": [
{
"id": 1,
"rating": "Positive",
"comment": "Thank you, resolved issue quickly.",
"submitted_date": "2023-12-11T11:47:45.434709Z",
"ticket_id": "13656171",
"tags": ["Knowledge", "Helpfulness", "Time to Response"]
}
],
"pagination": {
"page": 1,
"page_size": 10,
"total_results": 25
}
}
Pagination
Team GPS APIs support pagination to handle large data sets. Use the following parameters:
page: Specify the page number.page_size: Number of items per page.
Example:
GET https://api.teamgps.com/v1/csat-reviews?page=2&page_size=50
Error Codes and Handling
Common API errors include:
| Error Code | Description |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized (Invalid API Key) |
| 403 | Forbidden (Access Denied) |
| 404 | Resource Not Found |
| 429 | Rate Limit Exceeded |
| 500 | Internal Server Error |
Example Error Response (401 Unauthorized):
{
"message": "Invalid API key."
}
Integration Examples
Fetching All CSAT Reviews with Filters:
GET https://api.teamgps.com/v1/csat-reviews?page=1&page_size=10&from_submitted_date=2023-01-01&to_submitted_date=2023-12-31
Fetching Active Tickets:
GET https://api.teamgps.com/v1/tickets?status=active
Filtering by Date and Tag:
GET https://api.teamgps.com/v1/csat-reviews?tags=Knowledge&from_submitted_date=2023-01-01