Tag Object
Use tag resources to learn more about your Account Engagement tags. You can tag every asset in Account Engagement (including prospects and content) with keywords or key phrases. Use tags to classify, sort, and filter your Account Engagement information. Learn more about tags in [Salesforce Help](https://help.salesforce.com/articleView?id=sf.Account Engagement_segmentation_tags.htm).
Include the authentication header with every request. For information on how to authenticate, see Authentication.
| Resource Name | Operation | Description |
|---|---|---|
| Tag Query | GET | Request information for tags that match the specified criteria. |
| Tag Read | GET | Request information for a single tag. |
Request information for the tags that match the specified criteria. You can specify the tags and fields to request. A maximum of 200 records are returned. To return all tags, specify the output as mobile.
Use these parameters to specify the tags to return. Parameters can be used in any combination and in any order unless otherwise specified.
Notes:
- Parameters must be URL-encoded.
- Dates and times must use GNU Date Input Syntax (for example, yyyy-mm-dd:hh:ss
). - For a full listing of tag fields see Object Field References.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
created_after | string | today, yesterday, last_7_days, this_month, last_month,<custom_time> | Request tags created after the specified time. Example: To request tags created in 2020, use /api/tag/version/3/do/query?created_after=2019-12-31 24:59:59. |
created_before | string | today, yesterday, last_7_days, this_month, last_month, <custom_time> | Request tags created before the specified time. Doesn’t include tags created at the specified time. Example: To request tags created before today (but not created today), use /api/tag/version/3/do/query?created_before=today. |
id_greater_than | integer | Any positive integer | Request tags that have an ID greater than the specified number. |
id_less_than | integer | Any positive integer | Request tags that have an ID less than the specified number. |
name | string | Any string | Request tags that have the specified name. |
updated_after | string | today, yesterday, last_7_days, this_month, last_month, <custom_time> | Request tags that were last updated after the specified time. |
updated_before | string | today, yesterday, last_7_days, this_month, last_month, <custom_time> | Request tags that were last updated before the specified time. |
Use these parameters to specify the tag fields to return, and how the tags are sorted.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
limit | integer | Any integer from 1 through 200. | The number of tags to return. Default value is 200. |
offset | integer | Any positive integer | The number of tags to omit from the response (the number to "skip over"). Example: Retrieve a list of tags, omitting the 50 most recently updated records. Sort the query by the updated_at field and use offset=50: /api/tag/version/3/do/query?sort_by=updated_at&offset=50 |
sort_by | string | created_at, id, updated_at | The field by which the results are sorted. See Sort Order. |
sort_order | string | ascending, descending | The sort order. The default value depends on which sort_by parameter you specify. See Sort Order. |
Use sort_by to specify which field Account Engagement uses to sort the results. Different fields have different default sort orders.
| Value | Default Sort Order | Description |
|---|---|---|
created_at | descending | Sort the results by the tags' created_at timestamps. |
id | ascending | Sort the results by the tags' id fields. |
updated_at | descending | Sort the results by the tags' updated_at timestamps. |
Request information for a single tag.
Replace <ID> with the Account Engagement ID of the tag.
Request information about the tag with ID 1234.
The XML response for a query request contains information for multiple tags. The XML response for a read request contains information for a single tag.
| Tag | Description |
|---|---|
<result> | Parent tag. Contains information about the tags that match the parameters specified in your query. |
<total_results> | Contains the number of tags selected by the query. Note The query request returns a maximum of 200 tags. If your query matches more than 200 records, you can make several requests to retrieve all matching records. |
<tag> | The information about a single tag. See Tag in Object Field References for a complete description of fields. |
| Tag | Description |
|---|---|
<tag> | Contains information about a single tag. See Tag in Object Field References for a description of fields. |