Gets the comment facts. Run in API Explorer

GET /api/CommentFacts

Retrieves comments and their metadata for accounts in the specified period and engagement(s). Sample value of CommentFact

"AccountPeriodComment_Key": 294137, "Engagement_Key": 4316, "LegalEntity_Key": 294137, "Period_Key": 14631, "Account_Key": 294137, "AddedByUsername": "exampleuser@example.com", "AddedByName": "Example Name", "CommentText": "Ok - ", "CommentAdded": "2015-05-07T07:20:40.973Z", "UserKey": 232, "EngagementGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Query parameters

  • period string

    possible values : Current or 0 - Current period for filtered engagement(s), LastThree or 1(Default option) - Last three periods for filtered engagement(s), LastThirteen or 13 - Last thirteen periods for filtered engagement(s), LastTwentyFive or 25 - Last twenty five periods for filtered engagement(s), All or 99

  • Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1

Responses

GET /api/CommentFacts
curl \
 --request GET 'https://analyticsapi.adra.com/balancer/api/CommentFacts' \
 --user "username:password"
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]
Response examples (200)
[
  {
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "period_Key": 42,
    "fiscalYearPeriod_Key": 42,
    "account_Key": 42,
    "addedByUsername": "string",
    "addedByName": "string",
    "commentText": "string",
    "commentAdded": "2025-05-04T09:42:00Z",
    "accountPeriodComment_Key": 42,
    "userKey": 42,
    "engagementGuid": "string"
  }
]