Skip to main content

​
Query

query {
  accountItem(
    apiKey: String!
    id: String!
  ): AccountItem
}

​
Parameters

​
apiKey
string
required
Your Tellscope API key
​
id
string
required
The unique identifier of the account

​
Response

Returns a single AccountItem or null if not found.
​
id
string
Unique identifier
​
name
string
Account/company name
​
domain
string
Primary domain
​
description
string
Account description
​
website
string
Full website URL
​
score
float
Health score (0-1)
​
churnRisk
float
Churn risk score (0-1)
​
tags
array
Tags assigned to this account
​
createdAt
datetime
When the account was added

​
Example

query {
  accountItem(
    apiKey: "tellscp_sk_YOUR_API_KEY"
    id: "acc_xyz789"
  ) {
    id
    name
    domain
    description
    website
    score
    churnRisk
    tags
    createdAt
  }
}

​
Understanding the Response

​
Health Score

The score field represents the overall health of the account based on:
  • Feedback sentiment trends
  • Engagement frequency
  • Support ticket patterns
  • Feature adoption
Score RangeStatus
0.8 - 1.0Healthy
0.5 - 0.79Needs attention
0.0 - 0.49At risk

​
Churn Risk

The churnRisk field indicates the likelihood of the account churning:
Risk RangeLevel
0.0 - 0.2Low
0.2 - 0.5Medium
0.5 - 1.0High

​
Error Responses

​
Account Not Found

{
  "data": {
    "accountItem": null
  }
}

​
Not Authorized

If trying to access an account from another organization: 
{
  "errors": [
    {
      "message": "Not authorized to access this account",
      "extensions": {
        "code": "FORBIDDEN"
      }
    }
  ]
}