Scorecard has Atlas goal

The Teamwork Graph API is coming soon. The relationship types documented here are indicative of what will be available in the Graph via the Teamwork Graph API. Please note that relationships, their properties, and functionality may change before and during the Early Access Program.

Interested in early access? Express your interest in joining the EAP

The ScorecardHasAtlasGoal relationship represents the link between a Compass scorecard and a Townsquare goal within the Teamwork Graph. It allows you to:

Retrieve Atlas goals within a specific scorecard
Find which scorecard contains an Atlas goal
Traverse and analyze scorecard-goal relationships

Types

From Object Types	To Object Types
`Compass Scorecard - ati:cloud:compass:scorecard`	`Townsquare Goal - ati:cloud:townsquare:goal`

Cypher

Forward Query

GraphQL

1
2
query ScorecardHasAtlasGoal_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on TownsquareGoal {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

Note

We recommend sending parameterized Cypher queries as below instead of embedding the parameters directly in the query string. This approach will help ensure better performance.

1
2
{
  "cypherQuery": "MATCH (scorecard:CompassScorecard {ari: $id})-[:scorecard_has_atlas_goal]->(goal:TownsquareGoal) RETURN goal",
  "params": {
    "id": "$id"
  }
}

Inverse Query

GraphQL

1
2
query ScorecardHasAtlasGoal_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on CompassScorecard {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

Note

We recommend sending parameterized Cypher queries as below instead of embedding the parameters directly in the query string. This approach will help ensure better performance.

1
2
{
  "cypherQuery": "MATCH (scorecard:CompassScorecard)-[:scorecard_has_atlas_goal]->(goal:TownsquareGoal {ari: $id}) RETURN scorecard",
  "params": {
    "id": "$id"
  }
}