You are here:
Understand Root Resource and Resource IDs
The Digital Wallet data model includes two key identifiers, “Root Resource ID or API Name” and “Resource ID or API Name,” that capture what consumes credits in your consumption-based products. Knowing when each field populates or remains empty helps you accurately interpret usage reports and pinpoint what’s driving consumption.
See Report Scenarios for Root Resource and Resource ID Fields for example use cases.
| Field Name | Definition | Examples |
|---|---|---|
| Root Resource ID or API Name | Represents the top-level resource that initiates the credit consumption. Currently, this field is only populated when Agentforce agents initiate consumption. | Agentforce_Employee_Agent_NG, Sales_Agent,
Customer_Support_Agent |
| Root Resource Type | The object type of the root resource. It helps classify the initiating resource. | BotDefinition |
| Resource ID or API Name | Represents the specific resource or action that actually consumed the credits. This field represents the most granular level of usage (such as an agent action, a segment, or a data stream) and is populated for several billing events. |
|
| Resource Type | The object type of the specific resource, which provides additional context about what kind of feature consumed the credits and where its details are stored. |
|
Why is the “Root Resource ID or API Name” Field Sometimes Empty?
The Root Resource ID field is only populated when an Agentforce agent initiates the consumption. If your organization is consuming credits through non-agent features, such as Data 360 marketing segments, batch data pipelines, or data transforms, the Root Resource field remains empty. In these cases, the segment or pipeline is the primary resource.
Why Is the “Resource ID or API Name” Field Sometimes Empty?
Resources and their associated usage types, such as Data 360 Storage or Real-Time Profile Caching, calculate consumption at the overall org level using peak/snapshot capacity (MAX aggregation). Therefore, they don’t have a Resource ID associated with them.
When Are Both Root Resource ID and Resource ID Fields Populated?
You see both the Root Resource ID or API Name and Resource ID or
API Name fields populated when consumption is triggered by an agent that is an
action or a prompt.
Report Scenarios for Root Resource and Resource ID Fields
Learn how “Root Resource ID or API Name” and “Resource ID or API Name” fields behave across common scenarios and find recommended configurations for tracking them in your reports.
Agentforce Employee Agent
The Scenario: An employee interacts with an Agentforce Employee Agent to learn about company benefits. To answer the inquiry, the agent searches knowledge documents, triggering an "Answer question with knowledge" action.
- Root Resource ID: Agent API Name (
Agentforce_Employee_Agent_NG) - Root Resource Type:
BotDefinition - Resource ID: Action API Name (
AnswerQuestionWithKnowledge_<n>) - Resource Type:
GenAiFunctionDefinition
How to Build the Report
| Filters |
|
| Group Rows |
|
| Columns |
|
In this report, you can see the breakdown (by Resource) of the consumption for the Agentforce Employee Agent (Root Resource).
Data Cloud Segementation
The Scenario: A marketing team runs a July 4th Sales segment targeted at NYC customers to generate an email campaign list.
- Root Resource ID or API Name: Empty (not Agentforce Agent Flex Credit consumption)
- Resource ID or API Name: Segment name (July_4th_Segment)
- Resource Type:
MarketSegmentDefinition
How to Build the Report
This report is filtered to show only the Segmentation usage type. Units Consumed indicates the total sum of credits consumed across all runs of that segment.
| Filters |
|
| Group Rows |
|
| Columns |
|
Because the segment is not related to an agent, you don’t need to include Root Resource ID or API Name. If you do include it when building your report, it’s empty.
Batch Data Pipeline Ingestion
The Scenario: An account team ingests batches of invoice data into Data 360 to build unified customer profiles using a data stream called "NTO Event Prospect."
- Root Resource ID or API Name: Empty (not Agentforce Agent Flex Credit consumption)
- Resource ID or API Name: Data stream name (for example, NTO_Event_Prospect)
- Resource Type:
DataStreamDefinition
How to Build the Report
The report is filtered to show you only the Batch Data Pipeline usage type.
| Filters |
|
| Group Rows |
|
| Columns |
|
Because the segment is not related to an agent, you don’t need to include Root Resource ID or API Name. If you do include it when building your report, it’s empty.
