Get Program

GET /program

Get the program configuration settings used in processing and reporting events and actions.

Request Parameters

Header Parameters

Name	Type	Description
program-id required	string

Responses

200 Successful Response

Program | application/json

Name	Type	Properties
program_id required	string
program_name required	string
high_engagement_threshold	integer	description: This value is the number of actions establishing a user as 'highly engaged' (your best customers) for the purposes of inclusion in the engagement model.
event_relevance_decay	integer	description: This value is the number of days for events to lose half their weight (also called event half-life), implemented as a decay curve over time. This value is used to account for recency relevance so newer actions can carry extra weight in calculations. <br/>
action_weight_floor	number	description: This value is the minimum user action recommendation weight required for the action to be included in the final recommendations. Higher numbers bring higher confidence in the recommendations but also limit the number of recommendations provided.
description	string

Response Example

{
  "program_id": "string",
  "program_name": "string",
  "high_engagement_threshold": "integer",
  "event_relevance_decay": "integer",
  "action_weight_floor": "number",
  "description": "string"
}

404 User history not found

ErrorMessage | application/json

Name	Type	Properties
detail required	string

422 Validation Error

HTTPValidationError | application/json

Name	Type	Properties
detail	array	items: {'$ref': '#/components/schemas/ValidationError'}

ValidationError | application/json

Name	Type	Properties
loc required	array	items: {'anyOf': [{'type': 'string'}, {'type': 'integer'}]}
msg required	string
type required	string