Welcome to TrackMaven's API Documentation!

The TrackMaven API provides users with the ability to access the underlying data which powers the TrackMaven application.

Note: This documentation is still in beta and is being actively developed.

Getting Started

API Versioning

The current version of the TrackMaven API is v1, please make sure that all endpoints are pointing to /api/v1/ to ensure you are hitting the appropriate version of our API.

Backwards-incompatible changes to the API will lead to a change in version number. We will ensure that there is an appropriate transition period for customers to switch over to the new API version before retiring older versions.

Authenticating with the API

In order to start using the TrackMaven API, you should head into the application and retrieve your API token. Check out the Authentication section for more details.

Making a request

The TrackMaven API can be queried using any service that supports making HTTP requests. In our documentation, we have used curl to make example requests, but you can use your favorite programming language or explore the API from the browser.

Most requests require you to know which workspace you are getting data for. The workspace list endpoint is a good starting point!

The TrackMaven API returns data in JSON format by default, but can also return data in XML format. See the format query parameter for more detail.

Exploring the API

For more information about what data is available through the TrackMaven API, take a look at our endpoint descriptions:

• Workpace endpoints
• Brand endpoints
• Group endpoints
• Content endpoints
• Metrics endpoints