Reputation & Studies

Multi-model analyst reports: the monthly reputation scoring of your brand against its competitors, and the custom AI studies you define over any subjects and dimensions. Scores come from several analyst models independently, so compare models rather than averaging them blindly. Requires reputation monitoring on the account.

GET/reputation/reports

The monthly reputation reports for a project, newest first. Pending and failed reports are included on purpose, since whether this month ran at all is often the question being asked. Each row carries the report id, its status, and which analyst models produced data.

Params:
  • project_idrequired
  • page
  • per_page
  • output

GET/reputation/reports/:id

One report scores as flat rows: one row per analyst model, brand, dimension and attribute, with its 0-100 score and the reasoning the model gave. An unknown model returns ERR_INVALID_PARAM rather than an empty list, and brand is matched exactly rather than by substring.

Params:
  • project_idrequired
  • :idreport id
  • model
  • brandname or comma-separated list
  • dimension
  • page
  • per_page
  • output

GET/studies

The custom AI studies defined on the account. Studies belong to the account rather than to a project, so project_id is an optional filter here and account-level studies are returned whichever project you filter by.

Params:
  • project_idoptional
  • statusactive|archived
  • page
  • per_page
  • output

GET/studies/:id

One study with its brief, the subjects it compares, the dimensions it scores them on, and its report history. Use the ids in reports with the endpoint below.

Params:
  • :idstudy id

GET/studies/:id/reports/:report_id

One custom-study report scores as flat rows, in the same shape the reputation report scores use: one row per analyst model, subject, dimension and attribute.

Params:
  • :idstudy id
  • :report_id
  • model
  • subjectname or comma-separated list
  • dimension
  • page
  • per_page
  • output