Skip to main content

API Documentation

API documentation

Release Notes​

v2.1​

Added​

  • POST /api/v2/survey/{surveyCode}/response-curve — Response curve calculation for a survey study
  • POST /api/v2/survey/{surveyCode}/optimizations — Submit an asynchronous media plan optimization
  • GET /api/v2/optimizations/{jobId} — Retrieve the status of an optimization job
  • GET /api/v2/optimizations/{jobId}/result — Retrieve the result of an optimization job

v2.0​

Added​

  • POST /api/v2/reach/{surveyCode} — Reach table calculation (facade)
  • GET /api/v2/survey/{surveyCode}/reach-capabilities — Retrieve Reach capabilities of a survey
  • POST /api/v2/table/{surveyCode}/html — Retrieve the HTML render of a survey table
  • POST /api/v2/survey/{surveyCode}/tree/query — Lazy query of the variables/carriers tree (root, expand, search); may answer 206 Partial Content when the result is truncated
  • POST /api/v2/workspace/{workspaceId}/survey/{surveyCode}/tree/query/custom — Lazy query of the workspace custom tree

Fixed​

Changed​

  • GET /api/v2/survey/{surveyCode}/variables and /carriers now return 403 when the survey is not accessible to the user (not contracted, disabled/loading or non-existent)