USuseboom
Initiatives

Success-metric catalog

Changed on

List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative's conversations. Pass eventName to also get that event's properties, or objectTypeId to get that type's attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.

get/api/v1/initiatives/{id}/success-metrics/catalog

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

The initiative id.

Query parameters

eventNamestring

Also return this event's properties, for the value field of a SUM/AVERAGE/MAX metric.

objectTypeIdstring

Also return this custom-object type's attributes and its linkage paths to a person.

Response

Success

Changes