Response structure and objects
The following table describes the objects and keys that might be included in the response:
| Item | Description |
|---|---|
| ts | The timestamp of the server in milliseconds. |
| dt | The response processing time in milliseconds. |
| rid | The generated unique string for the response ID. |
| query2id | Unique ID of the query string sent in each type of query. |
| request_for | Contains a modified keyphrase if a suggestion parameter is added in the request. |
| facet | Available facets or attributes. The following key is related to facet - determines the order of the returned facets. |
| filter | Any filters selected in the request. |
| suggestion | Suggestions for the types provided. |
| appearance | HTML or CSS templates and variables for rendering a widget. |
| redirect_url | URL that the search redirects to, depending on the keyphrase. This is query.keyphrase related. |
| content | The result items for different types requested. The followings keys are related to content - number of content items reported.total_item - total number of content items available.page_number - current page number of the content results.total_page - number of content pages available.url - URL that represents the search request. |
| widget | The widget used to generate the response. The following keys are related to widget - unique experiment identifier for the split test entity in the Customer Engagement Console (CEC).experiment_bucket - unique generated string representing a bucket that the user is assigned to.variation_id - unique identifier that represents the variation in the CEC. |
| batch | A list of response keys or values that are specific to corresponding batched requests. It is a list of objects that you can use to override response-specific parameters. |
| errors | Returned if any errors were encountered while processing the request. A list of all such errors, with a message, description, severity level, and code for each of them is returned. |
| context_values | Returns any context values requested in the request. |
If you have suggestions for improving this article, let us know!