Skip to main content

API Reference

This page is a placeholder. We will add a real API reference later (for example OpenAPI).

What you will do​

  • Know what will live on this page
  • Use CLI help until the API docs exist
  • Collect logs for API-related problems

Steps​

1) What this page will include​

Planned items:

  • Auth and tokens
  • Download endpoints
  • Export formats
  • Error codes

2) Use the CLI help for now​

modtrack --help
modtrack export --help
modtrack analyze --help
modtrack excel --help

3) Collect details when you need support​

If a server call fails, collect:

  • Time of the request
  • Participant id
  • CLI version
  • Error message
  • Newest CLI log file

Logs:

  • macOS and Linux: ~/.modtrack/logs/
  • Windows: %APPDATA%\\modtrack\\logs\\

Common mistakes​

  • Assuming the API is stable without checking the CLI version
  • Sharing tokens in tickets or chat

Report issues​

Report issues with:

  • Steps to reproduce
  • CLI logs (remove secrets)
  • Any request id shown in logs (if available)