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
- Display Name
- Search Telemetry
- Primary Key
- searchtelemetryid
- Primary Key Attribute
- 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 |
PurgeRetainedContent | Not Bound |
Retain | Not Bound |
RollbackRetain | Not Bound |
UpdateMultiple | Not Bound |
UpsertMultiple | Not Bound |
ValidateRetentionConfig | Not Bound |