Connect REST API Developer Guide
jNewer Version Available
Business Objectives
- Resource
-
1/connect/business-objectives - Available version
- 59.0
- HTTP methods
- GET PATCH
- Request parameters for GET
-
Parameter Name Type Description Required or Optional Available Version channelId String Associated channel ID. Optional 59.0 includeInsightSummary Boolean Specifies whether to include an insight summary in the response. Default value is false. Optional 59.0 includeRecSummary Boolean Specifies whether to include a summary of recommended actions in the response. Default value is false. Optional 59.0 kpiName String Name of the key performance indicator. Optional 59.0 webstoreId String ID of the webstore to retrieve business objectives from. Required 59.0 - Response body for GET
- Business Objectives Summary
- Request body for PATCH
-
- Root XML tag
- BusinessObjectiveInputRepresentation
- JSON example
-
1{ 2 "businessObjectiveId": "0GO000000000001", 3 "insightSummary": { 4 "targetCompletionDate": "2024-12-31", 5 "targetValue": 1000000.00 6 } 7} - Properties
-
Name Type Description Required or Optional Available Version businessObjectiveId String ID of the business objective. Required 62.0 insightSummary Business Objective Insights Input A summary of insights about the business objective. Optional 62.0
- Response body for PATCH
- Business Objective Summary