Gets the period dimensions. Run in API Explorer

GET /api/PeriodDimensions
Basic Adra personal access token

This request should be used to retrieve information around fiscal periods and fiscal years, hereunder the fiscal period year name, the fiscal period names, and the corresponding date ranges. This would be information that is found under Administration->Fiscal years.

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/PeriodDimensions 
curl \
 --request GET 'https://analyticsapi.adra.com/balancer/api/PeriodDimensions' \
 --user "username:password"
Response examples (200) 
[
  {
    "Period": "2015-01-31 Jan",
    "PeriodEnd": "2015-01-31T00:00:00Z",
    "PeriodName": "Jan",
    "Period_Key": 14631,
    "PeriodStart": "2015-01-01T00:00:00Z",
    "PeriodStatus": "Reopened",
    "FiscalYearEnd": "2015-12-31T00:00:00Z",
    "Engagement_Key": 4316,
    "FiscalYearName": "2015",
    "PeriodSequence": 1,
    "FiscalYearStart": "2015-01-01T00:00:00Z",
    "LegalEntity_Key": 7854,
    "PeriodFrequency": "Month end",
    "PeriodCreatedDate": "2015-05-05T13:04:11.154Z",
    "FiscalYearPeriodId": 6101
  }
]