Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Nov 17, 2026

Confluence content has related entity

The Teamwork Graph API is available through Forge's Preview release phase.

Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.

New apps should use curated queries or persisted Cypher queries. Raw cypherQuery is unavailable to new apps; existing apps should follow Migrate from raw Cypher queries.

To review the current limitations, see Limitations and considerations.

To share feedback or report an issue, visit the Atlassian developer community.

Contains related entity ARIs for a piece of Confluence content, ranked by relevance.
A relationship is created for each recommended entity, with the relevance score stored as metadata.
Confluence-to-Confluence recommendations remain on confluence-content-has-related-confluence-content;
this relationship covers other Atlassian and third-party entities, such as Jira issues and Loom videos.

Relationship type: Activity

TTL (Time To Live): 180 days

From object typesTo object types
Confluence blogpost - ati:cloud:confluence:blogpostConfluence blogpost - ati:cloud:confluence:blogpost
Confluence page - ati:cloud:confluence:pageConfluence page - ati:cloud:confluence:page
External document - ati:cloud:jira:document, ati:cloud:graph:document

Cypher

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.

GraphQL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
query ConfluenceContentHasRelatedEntity_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ExternalDocument {
                  id
                }
                ... on ConfluencePage {
                  id
                }
                ... on ConfluenceBlogpost {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
3
4
5
6
7
{
  "cypherQuery": "MATCH (page:ConfluencePage {ari: $id})-[:confluence_content_has_related_entity]->(document:ExternalDocument) RETURN document",
  "params": {
    "id": "$id"
  }
}

Metadata

Relationship Metadata

NameTypeProperties
scoreFloat
productProduct (Enum)

Nested Types

Product

NameInternal NameIndex
unspecifiedPRODUCT_UNSPECIFIED0
confluencePRODUCT_CONFLUENCE100
google_drivePRODUCT_GOOGLE_DRIVE120
microsoft_sharepointPRODUCT_SHAREPOINT130

Rate this page: