FaxTrack API

Learn about the FaxTrack API and its functionality. The below documentation and examples use the form-data package to send files through the API. However, any method for this can be used.

GET /api/accounts/:id

Fetch a specific account and return the data

Parameters

`Authorization`	[Header] The API key that's set on the staff panel
`accountId`	[Param] [Required] Can be an account ID or Discord user ID

Response

{
  "id": "2",
  "username": "email@example.com",
  "permType": 1,
  "profileImg": "/attachments/CK6II7iKEy-dSwIuoYjAcAZES.png",
  "banned": 0,
  "discordId": "",
  "createdAt": "1655726232638"
}

POST /api/accounts

Create an account manually with the provided details.

Parameters

`Authorization`	[Header] The API key that's set on the staff panel
`username`	[Body] [Required] The username for the account
`avatar`	[Body] A link to a profile photo for the account
`discordID`	[Body] A Discord ID for the account
`banned`	[Body] Boolean value if the account should be banned

Response

401 - Unauthorized - Incorrect API token provided.
400 - Not Complete - Username not provided in request.
201 - Created - userID

POST /api/feedback/:projectID

Create a feedback topic on the provided project.

Parameters

`Authorization`	[Header] The API key that's set on the staff panel
`title`	[Body] [Required] The title for the topic
`description`	[Body] [Required] The description/body to use in the topic
`labels`	[Body] Labels to add to the topic, comma separated
`links`	[Body] Links to add to the topic, comma separated
`userId`	[Body] An optional account to link to the topic
`file`	[Files] Attachment to add to the topic. Only one is supported

Response

401 - Unauthorized - Incorrect API token provided
409 - Conflict - Duplicate content
400 - Bad Request - Invalid project ID
201 - Created - Returns a link to the topic

POST /api/issue/:projectID

Create an issue topic and attach it to the provided topic.

Parameters

`Authorization`	[Header] The API key that's set on the staff panel
`title`	[Body] [Required] The title for the topic
`description`	[Body] [Required] The description/body to use in the topic
`labels`	[Body] Labels to add to the topic, comma separated
`links`	[Body] Links to add to the topic, comma separated
`userId`	[Body] An optional account to link to the topic
`file`	[Files] Attachment to add to the topic. Only one is supported

Response

401 - Unauthorized - Incorrect API token provided
409 - Conflict - Duplicate content
400 - Bad Request - Invalid project ID
201 - Created - Returns a link to the topic

POST /api/stat/:statID

Add a statistic to a project's connected statistics.

Parameters

`:statID`	[URL] defines the statistic to send the data to
`title`	[Body] Add the title to add to the statistic entry
`data`	[Body] Contains the data object, an example is below
`expiresAt`	[Body] A MS timestamp of when the statistic entry will be deleted

Response Codes

201 = Created statistic.

Response Data

{"title":"My Title","data":{"Earned":2,,"Host":"your.domain"},"expiresAt":"1662092459618"}

For a code example see the FaxTrack Statistics Page