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).

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

  • engagement string

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

Responses

  • 200 application/json
  • 404 application/json

    Not Found

  • 400 application/json

    Bad Request

  • 500 application/json

    Internal Server Error

GET /api/CommentFacts
curl \
 --request GET 'https://analyticsapi.adra.com/balancer/api/CommentFacts' \
 --user "username:password"
Response examples (200)
[
  {
    "Period_Key": 14631,
    "Account_Key": 294137,
    "AddedByName": "Example Name",
    "CommentText": "Ok - ",
    "CommentAdded": "2015-05-07T07:20:40.973Z",
    "Engagement_Key": 4316,
    "AddedByUsername": "exampleuser@example.com",
    "LegalEntity_Key": 294137,
    "FiscalYearPeriod_Key": 256857,
    "AccountPeriodComment_Key": 294137
  }
]