searchtelemetry EntityType
Entity to log telemetry that used to improve search quality
- Entity set path:
- [organization URI]/api/data/v9.2/searchtelemetries
- Base type:
- crmbaseentity
- Table type:
- Elastic
- Display name:
- Search Telemetry
- Primary key:
- searchtelemetryid
- Primary name column:
- userquery
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||
|---|---|---|---|---|---|---|---|---|
| correlationid | Edm.String |
CorrelationId for the search Display name: CorrelationId |
||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||
| eyesonanalyticsallowed | Edm.Boolean |
If customer is allow our engineer to eye on Display name: EyesOnAnalyticsAllowed
Default options
|
||||||
| feedbackdata | Edm.String |
Feedback data for the search Display name: FeedbackData |
||||||
| partitionid | Edm.String |
Logical partition id. A logical partition consists of a set of records with same partition id. Display name: Partition Id |
||||||
| requestid | Edm.String |
RequestId for the search Display name: RequestId |
||||||
| scenarioname | Edm.String |
ScenarioName for the search, current will be one of RelevanceSearch/Marketing/Cxp Display name: ScenarioName |
||||||
| searchtelemetryid | Edm.Guid |
Unique identifier for entity instances Display name: SearchTelemetry Id |
||||||
| sessionid | Edm.String |
SessionId for the search Display name: SessionId |
||||||
| ttlinseconds | Edm.Int32 |
Time to live in seconds. Display name: Time to live |
||||||
| userquery | Edm.String |
User Query Display name: UserQuery |
||||||
| versionnumber | Edm.Int64 |
Version number of SearchTelemetry. Display name: Version Number Read only
|
Operations
The following operations can be used with the searchtelemetry entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| UpsertMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |