| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\napi\\_version\n\n | \n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nbefore\n\n | \n\nDate/time value. The request returns only records created prior to this date and time.Data type: String\n\nFormat: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\n\n |
| \n\ncontext\n\n | \n\nRequired. Sys\\_id of an activity context.Predefined activity contexts include Consumer and Contact.\n\nData type: String\n\nTable: Activity Context \\[sn\\_actsub\\_activity\\_context\\]\n\n |
| \n\ncontext\\_instance\n\n | \n\nRequired. Sys\\_id of an instance of the specified activity context, representing the initiator of the activities you want to retrieve. Located in the appropriate table for the activity context.As an example, if you set **context** to the sys\\_id of the Consumer activity context, set this parameter to the sys\\_id of the Consumer \\[csm\\_consumer\\] table record for the consumer whose activities you want to retrieve.\n\nData type: String\n\n |
| \n\nend\\_date\n\n | \n\nDate/time value. The request returns only records created during the time period defined by **start\\_date** and this parameter. Must be set along with **start\\_date**.Data type: String\n\n Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\n\n |
| \n\nfacets\n\n | \n\nComma-separated list of sys\\_ids of activity facet types to retrieve for the specified activity context.For more details on activity facets, see [Create facets for activity contexts](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/customer-service-management/create-facet-customer-central.md).\n\nData type: String\n\nDefault: Return all activity facet types configured for the activity context.\n\nTable: Activity Facet \\[sn\\_actsub\\_facet\\]\n\n |
| \n\nlast\n\n | \n\nIndex value of the first result row omitted from the response body. The result row index starts at 0, so the last row included in the response body is the one with the index **last**-1.For example, setting `last=5` omits rows with index 5 and above and returns at most only the first five result rows \\(with index values 0 through 4\\). Setting `stFrom=1` and `last=5` skips the first result row and returns the second through fifth result rows \\(with index values 1 through 4\\).\n\nData type: Number \\(integer\\)\n\nDefault: The value of the **com.snc.actsub.activities.api.fetch.limit** system property \\(10 by default\\).\n\n |
| \n\nrecord\\_id\n\n | \n\nSys\\_id of a record to use when rendering dynamic facets. Located in the appropriate table for the activity type you want to retrieve.For example, if you want to fetch activities for a Case record, set this parameter to the sys\\_id of the Case record in question.\n\nFor more details on dynamic facets, see [Create facets for activity contexts](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/customer-service-management/create-facet-customer-central.md).\n\nData type: String\n\n |
| \n\nstart\\_date\n\n | \n\nDate/time value. The request returns only records created during the time period defined by this parameter and **end\\_date**. Must be set along with **end\\_date**.Data type: String\n\n Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\n\n |
| \n\nstFrom\n\n | \n\nIndex value of the first result row to include in the response body. The result row index starts at 0.For example, `stFrom=2` skips the first two result rows and returns results from the third row onward.\n\nData type: Number \\(integer\\)\n\nDefault: 0\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nStatus code\n\n | \n\nDescription\n\n |
|---|---|
| \n\n200\n\n | \n\nSuccessful. The request was successfully processed.\n\n |
| \n\n400\n\n | \n\nBad Request. A bad request type or malformed request was detected. The response body **result.message** parameter describes the nature of the error.Example error messages:\n\n- `Make sure a valid context and context_instance are passed` or `Make sure a valid stream and user are passed` indicates that the request lacks one or both of the **context** and **context\\_instance** query parameters. These parameters are required.\n- `stFrom can not be greater than last` indicates that the **stFrom** query parameter value exceeds the **last** query parameter value.\n- `Please provide start_date and end_date` indicates that the request includes only one of the **start\\_date** and **end\\_date** query parameters, which cannot be used separately.\n- `start_date can not be ahead of end_date` indicates that the specified **start\\_date** query parameter value occurs after the specified **end\\_date** query parameter value.\n- `Provided context is not configured in the system` indicates that the **context** query parameter value does not represent a valid activity context.\n- `Make sure a valid context_instance is passed` indicates that the **context\\_instance** query parameter value does not represent a valid instance of the specified activity context.\n\n |
| \n\n401\n\n | \n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n |
| \n\n500\n\n | \n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nresult\n\n | \n\nResult object.Data type: Object\n\n```\n\n\"result\": {\n \"activities\": [Array],\n \"message\": \"String\",\n \"status\": Number,\n \"stream\": \"String\",\n \"user\": \"String\"\n}\n```\n\n |
| \n\nresult.activities\n\n | \n\nArray of objects in which each object represents an activity record from the specified activity context and context instance.Data type: Array of Objects\n\n```\n\"activities\": [\n {\n \"activity_type_id\": \"String\",\n \"content_fields\": [Array],\n \"created\": \"String\",\n \"icon\": \"String\",\n \"source_table_name\": \"String\",\n \"subheader_fields\": [Array],\n \"subobject_sys_id\": \"String\",\n \"subobject_table_name\": \"String\",\n \"sys_id\": \"String\",\n \"title\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.activities.activity\\_type\\_id\n\n | \n\nSys\\_id of the record from the Activity Types \\[sn\\_actsub\\_activity\\_type\\] table that corresponds to the type of this activity record.Data type: String\n\n |
| \n\nresult.activities.content\\_fields\n\n | \n\nArray of objects in which each object represents a field to display as content in the tile for the activity record.Data type: Array of Objects\n\n```\n\"content_fields\": [\n {\n \"deeplink_to_subobject\": \"String\",\n \"display_as_timeago\": \"String\",\n \"label\": \"String\",\n \"show_label\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.activities.content\\_fields.deeplink\\_to\\_subobject\n\n | \n\nFlag indicating whether or not the content field displays as a hyperlink to the record for the object on which this activity was performed.Valid values:\n\n- true: The content field displays as a hyperlink to the record for the object on which this activity was performed.\n- false: The content field displays as a hyperlink to the record for the object on which this activity was performed.\n\nData type: String\n\n |
| \n\nresult.activities.content\\_fields.display\\_as\\_timeago\n\n | \n\nFlag indicating whether or not the content field displays in time ago format.Valid values:\n\n- true: The content field displays in time ago format.\n- false: The content field does not display in time ago format.\n\nData type: String\n\n |
| \n\nresult.activities.content\\_fields.label\n\n | \n\nLabel for the content field.Data type: String\n\n |
| \n\nresult.activities.content\\_fields.show\\_label\n\n | \n\nFlag indicating whether or not the content field label displays for content field values in the tile for this activity record.Valid values:\n\n- true: The content field label displays for content field values in the tile for this activity record.\n- false: The content field label doesn't display for content field values in the tile for this activity record.\n\nData type: String\n\n |
| \n\nresult.activities.content\\_fields.type\n\n | \n\nType of the content field.Data type: String\n\n |
| \n\nresult.activities.content\\_fields.value\n\n | \n\nValue of the content field.Data type: String\n\n |
| \n\nresult.activities.created\n\n | \n\nCreation date/time for this activity record.Data type: String\n\nFormat: YYYY-DD-MM hh:mm:ss\n\n |
| \n\nresult.activities.icon\n\n | \n\nName of the icon displayed on the tile for this activity record.Data type: String\n\n |
| \n\nresult.activities.source\\_table\\_name\n\n | \n\nName of the table in which this activity record is located. Determined by the Activity Source defined in the Activity Types \\[sn\\_actsub\\_activity\\_type\\] table for the type associated with this activity record.\n\nData type: String\n\n |
| \n\nresult.activities.subheader\\_fields\n\n | \n\nArray of objects in which each object represents a field displayed in the subheader of the tile for this activity record.Data type: Array of Objects\n\n```\n\"subheader_fields\": [\n {\n \"deeplink_to_subobject\": \"String\",\n \"display_as_timeago\": \"String\",\n \"label\": \"String\",\n \"show_label\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.activities.subheader\\_fields.deeplink\\_to\\_subobject\n\n | \n\nFlag indicating whether or not the subheader field displays as a hyperlink to the record for the object on which this activity was performed.Valid values:\n\n- true: The subheader field displays as a hyperlink to the record for the object on which this activity was performed.\n- false: The subheader field doesn't display as a hyperlink to the record for the object on which this activity was performed.\n\nData type: String\n\n |
| \n\nresult.activities.subheader\\_fields.display\\_as\\_timeago\n\n | \n\nFlag indicating whether or not the subheader field displays in time ago format.Valid values:\n\n- true: The subheader field displays in time ago format.\n- false: The subheader field doesn't display in time ago format.\n\nData type: String\n\n |
| \n\nresult.activities.subheader\\_fields.label\n\n | \n\nLabel for the subheader field.Data type: String\n\n |
| \n\nresult.activities.subheader\\_fields.show\\_label\n\n | \n\nFlag indicating whether or not the subheader field label displays for subheader field values in the tile for this activity record.Valid values:\n\n- true: The subheader field label displays for subheader field values in the tile for this activity record.\n- false: The subheader field label doesn't display for subheader field values in the tile for this activity record.\n\nData type: String\n\n |
| \n\nresult.activities.subheader\\_fields.type\n\n | \n\nType of the subheader field.Data type: String\n\n |
| \n\nresult.activities.subheader\\_fields.value\n\n | \n\nValue of the subheader field.Data type: String\n\n |
| \n\nresult.activities.subobject\\_sys\\_id\n\n | \n\nSys\\_id of the record for the object on which this activity was performed. Located in the table specified in the **subobject\\_table\\_name** parameter value.Data type: String\n\n |
| \n\nresult.activities.subobject\\_table\\_name\n\n | \n\nName of the table containing the record for the object on which this activity was performed. Determined by the Table Name defined in the Activity Group \\[sn\\_actsub\\_subscribable\\_object\\] table for the group containing the activity type associated with this activity record.\n\nData type: String\n\n |
| \n\nresult.activities.sys\\_id\n\n | \n\nSys\\_id of this activity record. Located in the table specified as the **source\\_table\\_name** response body parameter value.Data type: String\n\n |
| \n\nresult.activities.title\n\n | \n\nTitle that displays on the tile for this activity record.Data type: String\n\n |
| \n\nresult.hasMoreRecords\n\n | \n\nFlag indicating whether or not the list of activities in the response body is truncated by the **last** query parameter value.Valid values:\n\n- true: The list of activities in the response body is truncated by the **last** query parameter value. Repeating the request with a higher **last** query parameter value will return additional activities for this context and context instance.\n- false: The list of activities in the response body isn't truncated by the **last** query parameter value. No further activities are available for this context and context instance.\n\nData type: String\n\n |
| \n\nresult.message\n\n | \n\nError message describing the problem encountered during request processing.Data type: String\n\n |
| \n\nresult.status\n\n | \n\nHTTP status code returned for request.Valid values: Refer to Status Codes.\n\nData type: Number\n\n |
| \n\nresult.stream\n\n | \n\nSys\\_id specified in request **context** query parameter.Data type: String\n\nTable: Activity Context \\[sn\\_actsub\\_activity\\_context\\]\n\n |
| \n\nresult.user\n\n | \n\nSys\\_id specified in request **context\\_instance** query parameter. Located in the appropriate table for the activity context.Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nactivity\\_context\n\n | \n\nSys\\_id of an activity context.Predefined activity contexts include Consumer and Contact. Navigate to **Customer Central** > **Customer Activity** > **Activity Contexts** to view the full list of activity contexts defined for your instance.\n\nData type: String\n\nTable: Activity Contexts \\[sn\\_actsub\\_activity\\_context\\]\n\n |
| \n\napi\\_version\n\n | \n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n |
| \n\ncontext\\_instance\n\n | \n\nSys\\_id of an instance of the specified activity context, representing the initiator of the activities you want to retrieve facets for.As an example, if you set **activity\\_context** to the sys\\_id of the Contact activity context, you should set this parameter to the sys\\_id of the Contact \\[customer\\_contact\\] record for the contact whose activity facets you want to retrieve.\n\nData type: String\n\nTable: In the context table specified for the activity context record in the Activity Contexts \\[sn\\_actsub\\_activity\\_context\\] table.\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nend\\_date\n\n | \n\nDate/time value. The request returns only records created during the time period defined by **start\\_date** and this parameter. Must be set along with **start\\_date**.Data type: String\n\n Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\n\n |
| \n\nfacets\n\n | \n\nComma-separated list of sys\\_ids of activity facets to retrieve for the specified activity context.To see the activity facet types defined for an activity context, navigate to **Customer Central** > **Customer Activity** > **Activity Contexts** and examine the **Facets** related list.\n\nData type: String\n\nDefault: Return all activity facets configured for the activity context.\n\n |
| \n\nget\\_activity\\_count\n\n | \n\nFlag indicating whether or not to include activity counts for each facet in the response body.Valid values:\n\n- true: Include facet activity counts.\n- false: Omit facet activity counts.\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nlazy\\_load\n\n | \n\nFlag indicating whether or not to improve performance by omitting facet activity data and activity counts from the response body. This parameter takes precedence over **get\\_activity\\_count**.Valid values:\n\n- true: Omit facet activity data and activity counts.\n- false: Retrieve facet activity data and activity counts.\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nstart\\_date\n\n | \n\nDate/time value. The request returns only records created during the time period defined by this parameter and **end\\_date**. Must be set along with **end\\_date**.Data type: String\n\n Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nStatus code\n\n | \n\nDescription\n\n |
|---|---|
| \n\n200\n\n | \n\nSuccessful. The request was successfully processed.\n\n |
| \n\n400\n\n | \n\nBad Request. A bad request type or malformed request was detected. The response body **result.message** parameter describes the nature of the error.Example error messages:\n\n- `Make sure a valid activity context details are passed` indicates that the **activity\\_context** path parameter value does not represent a valid activity context, the **context\\_instance** path parameter value does not represent a valid instance of the specified activity context, or both.\n- `Please provide start_date and end_date` indicates that the request includes only one of the **start\\_date** and **end\\_date** query parameters, which cannot be used separately.\n- `start_date can not be ahead of end_date` indicates that the specified **start\\_date** query parameter value occurs after the specified **end\\_date** query parameter value.\n\n |
| \n\n401\n\n | \n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n |
| \n\n500\n\n | \n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nresult\n\n | \n\nList of activity facets.Data type: Array of Objects\n\n```\n\"result\": [\n {\n \"activity_count\": Number,\n \"children\": [Array],\n \"facets\": [Array],\n \"icon\": \"String\",\n \"is_dynamic\": \"String\",\n \"message\": \"String\",\n \"name\": \"String\",\n \"status\": Number\n }\n]\n```\n\n |
| \n\nresult.activity\\_count\n\n | \n\nNumber of activity records included in this facet \\(and its children, if any. Only displayed when **lazy\\_load** query parameter is false and **get\\_activity\\_count** query parameter is true.Data type: Number\n\n |
| \n\nresult.children\n\n | \n\nArray of objects in which each object represents an activity record \\(if this is a dynamic facet\\) or a child facet \\(if this is a static facet\\).Data type: Array of Objects\n\n```\n\n\"children\": [\n {\n \"activity_count\": Number\n \"facet\": \"String\",\n \"icon\": \"String\",\n \"title\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.children.activity\\_count\n\n | \n\nNumber of activity records included in this child facet \\(and its children, if any\\). Only displayed when the **lazy\\_load** query parameter is false and the **get\\_activity\\_count** query parameter is true.Data type: Number\n\n |
| \n\nresult.children.created\n\n | \n\nCreation date/time for this activity record.Data type: String\n\nFormat: YYYY-MM-DD hh:mm:ss\n\n |
| \n\nresult.children.facet\n\n | \n\nSys\\_id of this child facet record.Data type: String\n\nTable: Activity Facet \\[sn\\_actsub\\_facet\\]\n\n |
| \n\nresult.children.icon\n\n | \n\nName of the icon associated with this child facet.Data type: String\n\n |
| \n\nresult.children.sys\\_id\n\n | \n\nSys\\_id of this activity record. Located in the appropriate table for the parent facet type.As an example, an activity record included in the Cases facet has a sys\\_id located in the Case \\[sn\\_customerservice\\_case\\] table.\n\nData type: String\n\n |
| \n\nresult.children.metadata\n\n | \n\nArray of objects in which each object includes activity record data for a facet field configured in the Activity Facet \\[sn\\_actsub\\_facet\\] table record for this facet type.Data type: Array of Objects\n\n```\n\n\"metadata\": [\n {\n \"key\": \"String\",\n \"label\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.children.metadata.key\n\n | \n\nName of this facet field.Data type: String\n\n |
| \n\nresult.children.metadata.label\n\n | \n\nLabel of this facet field.Data type: String\n\n |
| \n\nresult.children.metadata.type\n\n | \n\nType of this facet field.Data type: String\n\n |
| \n\nresult.children.metadata.value\n\n | \n\nValue of this facet field.Data type: String\n\n |
| \n\nresult.children.title\n\n | \n\nName of this activity record or child facet.Data type: String\n\n |
| \n\nresult.facets\n\n | \n\nList of sys\\_ids associated with this facet record. For a dynamic facet, this array contains the sys\\_id of the facet itself. For a static facet, it instead contains the sys\\_ids of all facets which are children of the facet.Data type: Array\n\n```\n\n\"facets\": [\n \"510d7e2e73570010e37d71ef64f6a70d\",\n \"bc9bfaaa73570010e37d71ef64f6a771\"\n]\n```\n\nTable: Activity Facet \\[sn\\_actsub\\_facet\\]\n\n |
| \n\nresult.icon\n\n | \n\nName of the icon associated with this facet.Data type: String\n\n |
| \n\nresult.is\\_dynamic\n\n | \n\nFlag indicating whether or not this facet is a dynamic facet. This value determines the type of information included in the **children** response body parameter.Possible values:\n\n- true: This is a dynamic facet. The **children** response body parameter value contains activity record details, and the **facets** parameter contains the dynamic facet sys\\_id.\n- false: This is a static facet \\(a facet group\\). The **children** response body parameter value contains child facets, and the **facets** parameter contains the sys\\_ids of these child facets.\n\nData type: Boolean\n\n |
| \n\nresult.message\n\n | \n\nError message describing problem encountered during request processing.Data type: String\n\n |
| \n\nresult.name\n\n | \n\nName of the facet or facet group.Data type: String\n\n |
| \n\nresult.status\n\n | \n\nHTTP status code returned for request.Possible values: See the Status Code table.\n\nData type: Number\n\n |