afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ConvAnalysisSummary.json

61 lines
2.2 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules"
],
"title": "ConvAnalysisSummary - Data API",
"description": "Represents the information stored for each run or refresh of Sales Signals. This object is available in API version 63.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"AnalysisDate": {
"type": "dateTime",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The date when the actual data analysis was done, accounting for the delay between the refresh start time and the data analysis."
},
"DataModelVersion": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "The data model version generated by Hawking."
},
"Error": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "The error message sent by Hawking when a refresh fails."
},
"FlowIdentifier": {
"type": "string",
"properties": "Create, Filter, Group, Sort",
"description": "The UUID used to track the Hawking flow ID.",
"required": true
},
"RefreshDate": {
"type": "dateTime",
"properties": "Create, Filter, Sort",
"description": "The date when the admin started the refresh of their ECI data for processing.",
"required": true
},
"Status": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The status of the refresh or run. Possible values are: FAILED PARTIALLY_FAILED PROCESSING SUCCESS",
"required": true
},
"TotalCalls": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The total number of calls that were analyzed for Sales Signals."
},
"TotalMentions": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The total number of mentions or keywords that were analyzed."
}
},
"special_access_rules": "Users need the Sales Signals permission set and the Sales Signals feature must be enabled."
}