API - Track History

Our API is intended for purely professional use. It enables server-to-server (S2S) communication between your server and the Track History server.

The main advantage of the API is the automation of your events. If you have a website or platform that conducts real-time transactions, you obviously won't want to manually report each transaction to your Track History account.

Additionally, the API also allows you to:

List your events
Manage your groups
Manage your categories
Manage your value types

Have a server capable of sending HTTP requests
Purchase API requests on Track History
Have some technical knowledge or hire a developer*

* If you do not have a developer, we can handle the installation if your infrastructure allows it.
This is however a paid service.

Create an account on Track History
Purchase API requests
Go to My API Accounts
Make sure you have at least one Active account
Copy the private key

The private key is only partially displayed on the interface! Clicking on it will allow you to copy it in full.

⚠️ Warning! A private key should only be used on the backend. Do not use it on the frontend (HTML, JavaScript, or any code that can be directly read in the browser).

⚠️ Only use the API if you know exactly what you're doing, as it poses a potential security risk to your Track History account.

You can use your private key either in the headers of your request as a Bearer token or in the request parameters.

In the examples below, replace your_private_key with the private key you copied.

1. Bearer token


                    curl -i https://api.track-history.com \

                    "Authorization: Bearer your_private_key"

2. Request parameter


                    https://api.track-history.com?token=your_private_key

API access URL: https://api.track-history.com

The parameters sent and the responses are always in JSON

Content-Type: application/json

> Group

Name	Route	Parameters / Response
List of groups	`GET /event-group`	Response `[ { "id": 1, "name": "Expenses", "description": "Analyze the amounts used each month", "photo": { "slug": "TeUqxthri2qlUKx7", "path": "event-group/photo/2024/03/29/TeUqxthri2qlUKx7.png", "size": 0.1 }, "defaultValues": [ { "eventGroupId": 1, "eventValueTypeId": 1, "value": 10, } ] } ]`
Count groups	`GET /event-group/count`	Response `1`
Retrieve a group	`GET /event-group/{id}`	Response `{ "id": 1, "name": "Expenses", "description": "Analyze the amounts used each month", "photo": { "slug": "TeUqxthri2qlUKx7", "path": "event-group/photo/2024/03/29/TeUqxthri2qlUKx7.png", "size": 0.1 }, "defaultValues": [ { "eventGroupId": 1, "eventValueTypeId": 1, "value": 10, } ] }`
Create a group	`POST /event-group`	Parameters `{ "name": "Expenses", "description": "Analyze the amounts used each month", "photo": { "data": "base64encodedfile", "extension": "png", }, "defaultValues": [ { "eventValueTypeId": 1, "value": 10, } ] }` Response (ID of the created group) `1`
Update a group	`PATCH /event-group/{id}`	Parameters `{ "name": "Expenses", "description": "Analyze the amounts used each month", "photo": { "data": "base64encodedfile", "extension": "png", }, "defaultValues": [ { "eventValueTypeId": 1, "value": 10, } ] }`
Delete a group	`DELETE /event-group/{id}`	No Response

> Category

Name	Route	Parameters / Response
List of categories	`GET /event-type`	Response `[ { "id": 32, "eventGroupId": 1, "name": "Rent", "description": "850€/Month", "photo": { "slug": "TeUqxthri2qlUKx7", "path": "event-type/photo/2024/03/29/TeUqxthri2qlUKx7.png", "size": 0.2 }, "defaultValues": [ { "eventTypeId": 32, "eventValueTypeId": 11, "value": 850, } ] } ]`
Retrieve a category	`GET /event-type/{id}`	Response `{ "id": 32, "eventGroupId": 1, "name": "Rent", "description": "850€/Month", "photo": { "slug": "TeUqxthri2qlUKx7", "path": "event-type/photo/2024/03/29/TeUqxthri2qlUKx7.png", "size": 0.2 }, "defaultValues": [ { "eventTypeId": 32, "eventValueTypeId": 11, "value": 850, } ] }`
Create a category	`POST /event-type`	Parameters `{ "eventGroupId": 1, "name": "Rent", "description": "850€/Month", "photo": { "data": "base64encodedfile", "extension": "png" }, "defaultValues": [ { "eventValueTypeId": 24, "value": 850, } ] }` Response (ID of the created category) `32`
Update a category	`PATCH /event-type/{id}`	Parameters `{ "eventGroupId": 1, "name": "Rent", "description": "850€/Month", "photo": { "data": "base64encodedfile", "extension": "png" }, "defaultValues": [ { "eventValueTypeId": 24, "value": 850, } ] }`
Delete a category	`DELETE /event-type/{id}`	No Response

> Value Type

Name	Route	Parameters / Response
List of value types	`GET /event-value-type`	Response `[ { "id": 24, "name": "", "symbol": "€", "criticalMin": 0, "criticalMax": 1000 } ]`
Retrieve a value type	`GET /event-value-type/{id}`	Response `{ "id": 24, "name": "", "symbol": "€", "criticalMin": 0, "criticalMax": 1000 }`
Create a value type	`POST /event-value-type`	Parameters `{ "name": "", "symbol": "€", "criticalMin": 0, "criticalMax": 1000 }` Response (ID of the created value type) `24`
Update a value type	`PATCH /event-value-type/{id}`	Parameters `{ "name": "", "symbol": "€", "criticalMin": 0, "criticalMax": 1000 }`
Delete a value type	`DELETE /event-value-type/{id}`	No Response

> Event

Name	Route	Parameters / Response
List of events	`GET /event`	Response [ { "id": 2356, "eventGroupId": 1, "eventTypeId": 32, "name": "July Rent", "description": "The landlord has raised the prices again", "status": "normal", "selfFulfilled": false, "photo": { "slug": "TeUqxthri2qlUKx7", "path": "event/photo/2024/03/29/TeUqxthri2qlUKx7.png", "size": 0.5 }, "trackingStartingDate": "2024-05-01 00:00:00", "trackingEndingDate": "2024-05-15 23:59:59", "notificationDate": null, "updateDate": "2024-05-01 12:27:54", "values": [ { "eventId": 2356, "eventValueTypeId": 24, "value": 850 } ] } ]
Retrieve an event	`GET /event/{id}`	Response { "id": 2356, "eventGroupId": 1, "eventTypeId": 32, "name": "July Rent", "description": "The landlord has raised the prices again", "status": "normal", "selfFulfilled": false, "photo": { "slug": "TeUqxthri2qlUKx7", "path": "event/photo/2024/03/29/TeUqxthri2qlUKx7.png", "size": 0.5 }, "trackingStartingDate": "2024-05-01 00:00:00", "trackingEndingDate": "2024-05-15 23:59:59", "notificationDate": null, "updateDate": "2024-05-01 12:27:54", "values": [ { "eventId": 2356, "eventValueTypeId": 24, "value": 850 } ] }
Create an event	`POST /event`	Parameters `{ "eventGroupId": 1, "eventTypeId": 32, "name": "July Rent", "description": "The landlord has raised the prices again", "status": "normal", "selfFulfilled": false, "photo": { "data": "base64encodedfile", "extension": "png" }, "trackingStartingDate": "2024-05-01 00:00:00", "trackingEndingDate": "2024-05-15 23:59:59", "notificationDate": null, "updateDate": "2024-05-01 12:27:54", "values": [ { "eventValueTypeId": 24, "value": 850 } ] }` Response (ID of the created event type) `2356`
Update an event	`PATCH /event/{id}`	Parameters `{ "eventGroupId": 1, "eventTypeId": 32, "name": "July Rent", "description": "The landlord has raised the prices again", "status": "normal", "selfFulfilled": false, "photo": { "data": "base64encodedfile", "extension": "png" }, "trackingStartingDate": "2024-05-01 00:00:00", "trackingEndingDate": "2024-05-15 23:59:59", "notificationDate": null, "updateDate": "2024-05-01 12:27:54", "values": [ { "eventValueTypeId": 24, "value": 850 } ] }`
Delete an event	`DELETE /event/{id}`	No Response

API Documentation

1. Presentation

2. Prerequisites

3. Steps to obtain a private key