Goal Metric
goalMetrics Based on latest (2026.09)
Look up Goal Metric, with goal metric breakdown and goal metric details. Read-only.
The record key goalMetricsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)
- Record key
goalMetricsUniqID- Required on create
- no create on this resource
- At a glance
- 44 fields4 finders2 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/goalMetrics?fields=Actual,CumulativeActual,CumulativeProgress,CumulativeTarget,CurrencyCode&limit=25&onlyData=true
{
"items": [
{
"Actual": 0,
"CumulativeActual": 0,
"CumulativeProgress": 0,
"CumulativeTarget": 0,
"CurrencyCode": "<string, max 4000>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 44
| Attribute | Type | Use |
|---|---|---|
Actual | number | Read-onlySearchable |
CumulativeActual | number | Read-onlySearchable |
CumulativeProgress | number | Read-onlySearchable |
CumulativeTarget | number | Read-onlySearchable |
CurrencyCode | text · max 4000 | Read-onlySearchable |
DenomActual | number | Read-onlySearchable |
DenomRollupActual | number | Read-onlySearchable |
ExcludeRootResource | text · max 1 | Read-onlySearchable |
Frequency | text · max 64 | Read-onlySearchable |
GoalEndDate | date-time | Read-onlySearchable |
GoalId | number | Read-onlySearchable |
GoalName | text · max 275 | Read-onlySearchable |
GoalNumber | text · max 64 | Read-onlySearchable |
GoalStartDate | date-time | Read-onlySearchable |
IsFirst | number | Read-onlySearchable |
IsGoalParticipant | text · max 1 | Read-onlySearchable |
IsLast | number | Read-onlySearchable |
IsResourceFromMyOrg | text · max 1 | Read-onlySearchable |
KPIAggregation | text · max 200 | Read-onlySearchable |
KPIId | number | Read-onlySearchable |
KPIName | text · max 275 | Read-onlySearchable |
KPINumber | text · max 64 | Read-onlySearchable |
KPIObject | text · max 40 | Read-onlySearchable |
ManagerId | number | Read-onlySearchable |
ManagerNumber | text · max 30 | Read-onlySearchable |
NoOfGoalPeriods | number | Read-onlySearchable |
NumerActual | number | Read-onlySearchable |
NumerRollupActual | number | Read-onlySearchable |
PersonId | number | Read-onlySearchable |
Progress | number | Read-onlySearchable |
ResourceAvatarUri | text | Read-onlySearchable |
ResourceId | number | Read-onlySearchable |
ResourceName | text · max 900 | Read-onlySearchable |
ResourceNumber | text · max 30 | Read-onlySearchable |
RollupActual | number | Read-onlySearchable |
RollupCumulativeActual | number | Read-onlySearchable |
RollupCumulativeProgress | number | Read-onlySearchable |
RollupCumulativeTarget | number | Read-onlySearchable |
RollupProgress | number | Read-onlySearchable |
RollupTarget | number | Read-onlySearchable |
Target | number | Read-onlySearchable |
TargetEndDate | date-time | Read-onlySearchable |
TargetStartDate | date-time | Read-onlySearchable |
UOMCode | text · max 40 | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 4
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findActiveScheduledCompleted·bindEffectiveDatefindCompleted·bindEffectiveDatefindEffectiveDated·bindEffectiveDatefindScheduled·bindEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 2
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}/child/<name>. Add them to a GET with expand.
GoalMetricBreakdownGET Goal Metric Breakdowns · 18 fieldsBreakdownFrequencyBreakdownMeasuredAliasBreakdownMeasurementDateBreakdownPeriodEndDateBreakdownPeriodStartDateDayActualDenomDayActualDenomPeriodRunningActualGoalFrequencyGoalIdIsForLaterDateKPIIdLastDayOfPeriodNoOfDaysInPeriodNumerDayActualNumerPeriodRunningActualPeriodRunningActualResourceIdGoalMetricDetailsGET Goal Metric Detail · 28 fields · 1 findersActualCumulativeActualDenomActualDenomCumulativeActualDenomRollupActualDenomRollupCumulativeActualFrequencyGoalIdGoalNameGoalNumberKPICategoryCodeKPICategoryNameKPIIdKPINameKPINumberKPIObjectNumerActualNumerCumulativeActualNumerRollupActualNumerRollupCumulativeActualResoruceNumberResourceIdResourceNameRollupActualRollupCumulativeActualTargetEndDateTargetStartDateUOMCode
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/goalMetricsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findActiveScheduledCompletedfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:Actual, notactual. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.