Trax

Trax API

Trax API as documented publicly: 48 operations. Contract generated from the documentation by API Evangelist (2026-10-20); not the provider's own document.

GitHub OpenAPI

Operations 48

GET /api/{versionNumber}/{projectName}/{entities} Pagination is available with certain routes where the quantity of the data returned may be large. #
POST /api/{versionNumber}/{projectName}/analysis-results/queue/ack Acknowledge the reception of messages pulled from the queue and remove them from it. #
POST /api/{versionNumber}/{projectName}/analysis-results/queue/pull Pull messages from the analysis results queue to extract headers and links to analysis results files. #
GET /api/{versionNumber}/{projectName}/analysis-results/queue/size Determine the size of the analysis results queue. #
POST /api/{versionNumber}/{projectName}/async-job This method should be used to add an asynchronous job to Trax servers, with the request to add/remove/modify entities. #
GET /api/{versionNumber}/{projectName}/async-job/status/{async}-job-id A client may use the returned job identifier id to query the progress of the job. #
GET /api/{versionNumber}/{projectName}/entity/assortment Retrieve assortments data #
GET /api/{versionNumber}/{projectName}/entity/product Retrieve products data #
GET /api/{versionNumber}/{projectName}/entity/routes Retrieve Routes Data #
GET /api/{versionNumber}/{projectName}/entity/store Retrieve Stores Data #
GET /api/{versionNumber}/{projectName}/entity/store/audit_cycle_set Retrieve Store Audit Cycle data #
GET /api/{versionNumber}/{projectName}/entity/store/branches Retrieve branches data #
GET /api/{versionNumber}/{projectName}/entity/store/district API endpoint to get information about District entities #
GET /api/{versionNumber}/{projectName}/entity/store/region API endpoint to get information about Region entities #
GET /api/{versionNumber}/{projectName}/entity/store/retailer API endpoint to get information about Retailer entities #
GET /api/{versionNumber}/{projectName}/entity/store/states Retrieve State data #
GET /api/{versionNumber}/{projectName}/entity/store/store_type API endpoint to get information about Store Type entities. #
GET /api/{versionNumber}/{projectName}/entity/task Retrieve Task data #
GET /api/{versionNumber}/{projectName}/entity/user Querying users from Trax #
POST /api/{versionNumber}/{projectName}/metadata-file A method to update Trax with general metadata files, commonly used for configuration for KPI-related metadata. #
GET /api/{versionNumber}/{projectName}/metadata-file/status/{metadata}-file-id Query the metadata file job status. #
PUT /api/{versionNumber}/{projectName}/session/{sessionUid} API endpoint for submitting Session information as part of Visit Data #
PUT /api/{versionNumber}/{projectName}/session/{sessionUid}/scenes/{sceneUid} Route for sending a scene data to Trax API endpoint for submitting Scene information as part of Visit Data. #
PUT /api/{versionNumber}/{projectName}/session/{sessionUid}/scenes/{sceneUid}/images/{my}-image-uid PUT Route for sending a image data to Trax API endpoint for submitting Images information as part of Visit Data #
DELETE /api/notifier/public/{projectName}/subscription Delete subscription configuration for a project. #
GET /api/notifier/public/{projectName}/subscription Retrieve subscription configuration for a project. #
PUT /api/notifier/public/{projectName}/subscription Update subscription configuration with URLs and wave types. #
GET /api/v4/my-project/analysis-results/queue/ack GET /api/v4/my-project/analysis-results/queue/ack #
GET /api/v4/my-project/analysis-results/queue/pull GET /api/v4/my-project/analysis-results/queue/pull #
PUT /api/v4/my-project/sessions/my-session-UID PUT /api/v4/my-project/sessions/my-session-UID #
PUT /api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID PUT /api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID #
PUT /api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID/images/my-image-uid PUT /api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID/images/my-image-uid #
POST /api/v5/{projectName}/entity/products/import Import a File #
DELETE /api/v5/{projectName}/entity/products/import/{importId} Delete an Import #
GET /api/v5/{projectName}/entity/products/import/details/{importId} Get Import Details by ID #
GET /targets/api/{versionNumber}/projects/{projectName}/uploads Retrieve all uploaded targets data files with all available data from Trax. #
POST /targets/api/{versionNumber}/projects/{projectName}/uploads Upload an Excel or CSV file with targets data to one set of KPIs. #
GET /targets/api/{versionNumber}/projects/{projectName}/uploads/{uploadId}/download-errors Retrieve the errors found in an uploaded targets data file during validation. #
POST /targets/api/{versionNumber}/projects/{projectName}/uploads/{uploadId}/finalize Finalize Upload (commit data to the database). #
POST /targets/api/{versionNumber}/projects/{projectName}/uploads/batch Upload an Excel file with target data to multiple KPIs (Batch). #
GET /targets/api/{versionNumber}/projects/{projectName}/uploads/details/{uploadId} Retrieve an uploaded targets data file with all available data (source file, metadata, status etc.) from Trax. #
GET /targets/api/{versionNumber}/projects/{projectName}/uploads/download Retrieve an excel file with all (active and historical) target data from Trax. #
POST /targets/api/{versionNumber}/projects/{projectName}/uploads/update/{uploadId} Replace the uploaded file or change the variable group of a previously uploaded file. #
GET /targets/api/v4/my-project/uploads/62f4f1dd68bcdd097cca1938/download-errors GET /targets/api/v4/my-project/uploads/62f4f1dd68bcdd097cca1938/download-errors #
GET /targets/api/v4/my-project/uploads/details/62f4f1dd68bcdd097cca1938 GET /targets/api/v4/my-project/uploads/details/62f4f1dd68bcdd097cca1938 #
GET /targets/api/v4/projects/myproject/uploads/62f4f1dd68bcdd097cca1938/finalize GET /targets/api/v4/projects/myproject/uploads/62f4f1dd68bcdd097cca1938/finalize #
GET /targets/api/v4/projects/myproject/uploads/batch GET /targets/api/v4/projects/myproject/uploads/batch #
GET /targets/api/v4/projects/myproject/uploads/update/62f4f1dd68bcdd097cca1938 GET /targets/api/v4/projects/myproject/uploads/update/62f4f1dd68bcdd097cca1938 #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/openapi/_ae-authored/trax-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-put-api-versionnumber-projectname-session-sessionuid-scenes-sceneui2-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-api-versionnumber-projectname-entity-store-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-targets-api-versionnumber-projects-projectname-uploads-details-u-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-post-targets-api-versionnumber-projects-projectname-uploads-update-u2-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-targets-api-versionnumber-projects-projectname-uploads-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-api-versionnumber-projectname-metadata-file-status-metadata-file-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/trax:trax-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trax-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Trax API
  version: '2026-10-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-20: 48 operation(s) read from 29 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Trax has published no machine-readable contract that
    the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 32
    documentation: 16
    pages-with-code: 24
    pages-read: 29
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-20'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://www.apidoc.traxretail.com/tasks
  - https://www.apidoc.traxretail.com/routes
  - https://www.apidoc.traxretail.com/states
  - https://www.apidoc.traxretail.com/stores
  - https://www.apidoc.traxretail.com/regions
  - https://www.apidoc.traxretail.com/targets
  - https://www.apidoc.traxretail.com/branches
  - https://www.apidoc.traxretail.com/notifier
  - https://www.apidoc.traxretail.com/products
  - https://www.apidoc.traxretail.com/stores-1
  - https://www.apidoc.traxretail.com/users-v4
  - https://www.apidoc.traxretail.com/users-v5
  - https://www.apidoc.traxretail.com/districts
  - https://www.apidoc.traxretail.com/retailers
  - https://www.apidoc.traxretail.com/async-jobs
  - https://www.apidoc.traxretail.com/notifier-1
  - https://www.apidoc.traxretail.com/pagination
  - https://www.apidoc.traxretail.com/store-type
  - https://www.apidoc.traxretail.com/assortments
  - https://www.apidoc.traxretail.com/visit-types
  - https://www.apidoc.traxretail.com/images-input
  - https://www.apidoc.traxretail.com/scenes-input
  - https://www.apidoc.traxretail.com/metadata-file
  - https://www.apidoc.traxretail.com/authentication
  - https://www.apidoc.traxretail.com/sessions-input
  - https://www.apidoc.traxretail.com/audit-cycle-sets
  - https://www.apidoc.traxretail.com/product-import-v2
  - https://www.apidoc.traxretail.com/store-audit-cycles
  - https://www.apidoc.traxretail.com/retreive-analysis-results
servers:


# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/openapi/_ae-authored/trax-openapi-generated.yml