Cannot get customfield in grphql Goals

nick_pearson

Hi 

I am using graphql and the Atlassian Developer to perform two main tasks:
1. Extract details of a given Goal and a given Metric showing a Custom Field 
2. Update a Metric Performance

The eventual objective is to automate the update of Metrics from our Business Metrics held in google sheets.

My first problem is trying to access the list of Custom Fields and identify the custom field I need to update.

I have the following GraphQL which extracts a given Goal (I have obscured the ARI):

query GoalQuery2 {
goals_byIds(goalIds: "ari:cloud:townsquare:xxxxxxxxx:goal/55541a4f-7a34-4d10-9170-154ea141cf2b") @optIn(to: "Townsquare")
{
name
status {
value
}
progress {
percentage
type
}
}
}

The above works and produces the following result:
{
"data": {
"goals_byIds": [
{
"name": "Increase new customers who graduate to paying subscribers",
"status": {
"value": "pending"
},
"progress": {
"percentage": 0.04713804713804714,
"type": "AVERAGE_SUCCESS_MEASURE_ROLLUP"
}
}
]
},
"extensions": {
"gateway": {
"request_id": "db620beb-37d4-4bf9-a9f5-5d3eff47b9c2",
"trace_id": "db620beb37d44bf9a9f55d3eff47b9c2",
"crossRegion": false,
"edgeCrossRegion": false
}
}

When I then include the code to pull the Custom Field 

query GoalQuery2 {

  goals_byIds(goalIds: "ari:cloud:townsquare:xxxxxxxgoal/55541a4f-7a34-4d10-9170-154ea141cf2b")  @optIn(to: "Townsquare")

  {

    name

    status {

      value

    }

    progress {

      percentage

      type

    }

customFields {

      edges {

        node

      }

    }

    }

  }

It fails as follows:

{
"errors": [
{
"message": "Validation error (SubselectionRequired@[goals_byIds/customFields/edges/node]) : Subselection required for type 'TownsquareCustomField' of field 'node'",
"locations": [
{
"line": 14,
"column": 10
}
],
"extensions": {
"classification": "ValidationError",
"errorSource": "GRAPHQL_GATEWAY",
"statusCode": 400
}
}
],
"extensions": {
"gateway": {
"request_id": "4c790695-6aa3-495c-90a9-5d4e7f781c18",
"trace_id": "4c7906956aa3495c90a95d4e7f781c18",
"crossRegion": false,
"edgeCrossRegion": false
}
}
}

Can you help me to find the correct syntax please?

Also another second question:

2. I could only get the code above to work based on the Goal UUID which is hard for me to find (I had to use a web browser in dev mode to find it). Is there an easier way to run a graphQL to list all Goals Key and then use that?  Or is there a way in graphQL to list all the Goals UUID?

Thank you for any help you can give

Jorge Cammarota_rnitw6

It looks like you’ve hit two distinct walls: the GraphQL syntax for customFields (the "Subselection required" error) and the challenge of listing Goals without hardcoding ARI/UUIDs.

Correct Syntax for customFields in goals_byIds

The error Subselection required for type 'TownsquareCustomField' of field 'node' means that node is an object, not a scalar. In GraphQL, when a field returns an object, you must explicitly define which sub-fields you want.
The Fix

You need to specify the fields inside the node. Since customFields often use interfaces or unions, you should use inline fragments (... on TypeName) to access the specific values.
GraphQL

query GoalQuery2 {
goals_byIds(
goalIds: "ari:cloud:townsquare:xxxxxx:goal/55541a4f-7a34-4d10-9170-154ea141cf2b"
) @optIn(to: "Townsquare") {
name
status {
value
}
progress {
percentage
type
}
customFields {
edges {
node {
id
name
key
__typename # Useful to identify the specific type

# Use fragments to get the value based on the field type
... on TownsquareTextCustomField {
value
}
... on TownsquareNumberCustomField {
value
}
... on TownsquareSelectCustomField {
option {
id
value
}
}
}
}
}
}
}

Key Points:

edges { node { ... } } always requires sub-fields inside the node.

If you aren't sure which types exist yet, query only the metadata (id, name, key, __typename) first. The __typename will tell you exactly which fragment to use.

2. How to Find Goals Without the ARI/UUID

You don't have to use goals_byIds exclusively. You can use search or listing queries to find the IDs dynamically.
2.1. Listing Goals by Workspace or Filter

Use goals_search to list goals and retrieve their ARIs:
GraphQL

query ListGoals {
goals_search(
query: {
# Optional filters
# text: "client"
# status: [PENDING, IN_PROGRESS]
}
first: 50
) @optIn(to: "Townsquare") {
edges {
node {
id # This is the ARI you need for updates
key # Human-readable key/slug
name
status {
value
}
}
}
}
}

2.2. Filtering by Text (Goal Name)

If you only have the name of the goal from a spreadsheet, search for it:
GraphQL

query SearchGoalsByName {
goals_search(
query: {
text: "Increase New Customers"
}
first: 10
) @optIn(to: "Townsquare") {
edges {
node {
id
name
}
}
}
}

3. Linking to Google Sheets Automation

Suggested Workflow:

Preparation: Your Google Sheet should have a column for the Goal Name (or internal Key) and a column for the Metric Value.

Resolution: Your script (Apps Script) calls goals_search to map the "Goal Name" from the sheet to the "Goal ARI (ID)" from the API.

Identification: Fetch the customFields for that ID to find which fieldId matches the metric you want to update.

Execution: Run a mutation (e.g., goalMetric_update or customField_update) passing the Goal ARI, the Custom Field ID, and the Value from the spreadsheet.

Tente implementar essas alterações e me avise se surgirem outros erros.