analytics

Get Objective Outcomes

Compare objectives on real outcomes — contacted, replied, verified meetings.

A legacy outreach campaign is an objective now — pass its objective id, not the campaign id.

Answers "which of these objectives actually worked" for up to 100 objectives in one call, over an explicit UTC window. Every objective you ask for comes back, including ones with no usable data — those carry availability: "unavailable" rather than being dropped or reported as zero, so an objective never looks like a failure when it is really just unmeasured.

Use get_performance_metrics instead for funnel and time-series views of the whole account; this tool is for ranking specific objectives against each other on a like-for-like cohort.

Reading the response:

  • outcome_cutoff is the "as of" moment. A reply or meeting counts only if it happened by then, so an objective that started last week is not punished for outcomes that have not had time to land. Keep it identical across objectives you intend to compare.
  • meetings counts people with a verified meeting: it started by outcome_cutoff and was not cancelled, internal, or marked as a no-show. booked_meetings counts the other people with a live booking that has not started: progress, never a result.
  • coverage_complete: false means attribution for that objective is still incomplete. Report the numbers, but do not rank on them — that is the difference between "performed badly" and "we cannot tell yet".
  • data_watermark is how far message and meeting ingestion has caught up. Outcomes after the watermark are not in these numbers yet.
  • computed_at stamps the calculation, which is worth quoting when the same window is re-run later and moves.

Window rules the server enforces: all three timestamps must carry a UTC offset, start_at < end_at <= outcome_cutoff, and outcome_cutoff cannot be in the future. objective_ids must be unique.

post/api/analytics/objective-outcomes

Request

  • Base URL: https://api.vruum.ai
  • URL: https://api.vruum.ai/api/analytics/objective-outcomes
  • Auth: HTTPBearer (a scheme the document does not define)

Request body

objective_idsstring[] required
start_atstring date-time required
end_atstring date-time required
outcome_cutoffstring date-time required

Response

Successful Response

computed_atstring date-time required
outcome_cutoffstring date-time required
coverage_completeboolean required
coverage_warningstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.