Skip to main content

Telcofy REST Endpoints

Quick reference to Telcofy’s externally exposed REST endpoints. All paths are relative to:

  • Users API – https://users.api.telcofy.ai
  • Data API – https://data.api.telcofy.ai

See authentication.md for header requirements and token exchange details.


Users Admin API

MethodPathDescriptionAuth
GET/users/:uid/machine-accounts/listList machine-account labels available to the customer.x-api-key
POST/users/:uid/machine-accountsCreate or rotate a machine-account API key.x-api-key
POST/login-with-apikeyExchange an API key for a 1-hour Google OAuth token.x-api-key
GET/admin/mapsList saved admin maps (custom polygons, grids).x-api-key
POST/admin/mapsCreate a new admin map.x-api-key
PUT/admin/maps/:idUpdate an existing admin map.x-api-key
DELETE/admin/maps/:idDelete an admin map.x-api-key
GET/maps/monitoredList map IDs currently flagged for realtime monitoring.x-api-key

Data API

MethodPathDescriptionAuth
GET/data-aggRun a synchronous aggregation (activities or trips).x-api-key
POST/data-aggSubmit an aggregation job (full=true exports to Cloud Storage).x-api-key
GET/data-agg/status/:jobIdCheck aggregation job status and progress.x-api-key
GET/data-agg/results/:jobIdRetrieve preview results or export metadata (?full=true).x-api-key
GET/data-agg/jobsList historical aggregation jobs for the caller.x-api-key
POST/realtimeEnable or disable realtime monitoring for a saved map.x-api-key

Response Formats

  • All responses are JSON encoded and include an error field on failures.
  • Timestamp fields follow ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) unless noted.
  • Long-running jobs surface progress via /data-agg/status/:jobId and deliver export URLs via /data-agg/results/:jobId?full=true.

Refer to quickstart.md for example requests and to the individual service readmes for in-depth payload schemas.