get_abr_trend

What it answers

Read monthly ABR and trailing twelve-month rolling ABR, with definitions, import freshness and skipped-entry caveats. Optionally filter one client, serviceLine or product attribute using values discovered with list_abr_filter_values. Read parakeeto://methodology for shared response conventions and INVALID_ARGUMENT guidance.

Read-only.

Arguments

Returned fields

The result is an envelope: ok: true with data, or ok: false with error. Error codes: MODEL_CALCULATOR_ACCESS_REQUIRED, PAYROLL_GRID_MISSING, PAYROLL_GRID_REQUIRED, PROJECT_GRID_REQUIRED, EXPENSE_GRID_REQUIRED, PAYROLL_ENTRY_REFERENCE_STALE, ACCOUNT_NOT_FOUND, ACCOUNT_CONFIGURATION_MISSING, NO_IMPORTED_TIME, NOTHING_IMPORTED, ACCOUNT_REQUIRED, NO_REACHABLE_ACCOUNTS, FEATURE_NOT_ENTITLED, PERMISSION_DENIED, CALCULATION_FAILED, INTERNAL_ERROR, INVALID_ARGUMENT.

• data: object
  • data.account: string (uuid)
  • data.filter: object or null
    • data.filter.attribute: string ("client", "serviceLine", "product")
    • data.filter.values: array of string (minItems: 1)
  • data.months: array of object
    • data.months[].month: string (pattern ^\d{4}-(?:0[1-9]|1[0-2])$)
    • data.months[].abr: string or null (pattern ^-?\d+(?:\.\d+)?$)
    • data.months[].rollingAbr: string or null (pattern ^-?\d+(?:\.\d+)?$)
  • data.freshness: array of object
    • data.freshness[].source: string ("time-entries", "role-task-mappings", "annual-days", "dashboard-inputs")
    • data.freshness[].everCompleted: boolean
    • data.freshness[].completedAt: string (date-time) or null
  • data.gridFreshness: array of object
    • data.gridFreshness[].kind: string ("payroll", "expense", "project")
    • data.gridFreshness[].gridId: string (uuid)
    • data.gridFreshness[].name: string
    • data.gridFreshness[].storage: string ("sheet", "database")
    • data.gridFreshness[].sheetRefreshedAt: string (date-time) or null
  • data.definitions: map of string to string, optional
    • data.definitions.*: string
  • data.caveats: array of object
    • data.caveats[].code: string ("unmatched-projects", "filter-exclusions")
    • data.caveats[].message: string
    • data.caveats[].skippedEntryCount: string (pattern ^(0|[1-9]\d*)$)
    • data.caveats[].projectNames: array of string
    • data.caveats[].distinctProjectCount: integer (minimum: 0)
    • data.caveats[].projectNameLimit: number (10)
    • data.caveats[].remainingProjectCount: integer (minimum: 0)

On failure:

• error: object
  • error.code: string ("MODEL_CALCULATOR_ACCESS_REQUIRED", "PAYROLL_GRID_MISSING", "PAYROLL_GRID_REQUIRED", "PROJECT_GRID_REQUIRED", "EXPENSE_GRID_REQUIRED", "PAYROLL_ENTRY_REFERENCE_STALE", "ACCOUNT_NOT_FOUND", "ACCOUNT_CONFIGURATION_MISSING", "NO_IMPORTED_TIME", "NOTHING_IMPORTED", "ACCOUNT_REQUIRED", "NO_REACHABLE_ACCOUNTS", "FEATURE_NOT_ENTITLED", "PERMISSION_DENIED", "CALCULATION_FAILED", "INTERNAL_ERROR", "INVALID_ARGUMENT")
  • error.argument: string, optional (minLength: 1)
  • error.message: string
  • error.accounts: array of object, optional
    • error.accounts[].id: string (uuid)
    • error.accounts[].name: string
  • error.payrollGrids: array of object, optional
    • error.payrollGrids[]: same shape as error.accounts[]
  • error.projectGrids: array of object, optional
    • error.projectGrids[]: same shape as error.accounts[]
  • error.expenseGrids: array of object, optional
    • error.expenseGrids[]: same shape as error.accounts[]
  • error.context: object, optional
    • error.context.account: object
      • Further fields: see the response.
    • error.context.imports: array of object
      • Further fields: see the response.
    • error.context.hasTimeEntries: boolean
    • error.context.reports: array of object
      • Further fields: see the response.

Definitions

Returned in definitions when includeDefinitions is true (the default). It is a map of string to string: each key names a field and each value is its definition text.

Caveats

• unmatched-projects, filter-exclusions. Also carries skippedEntryCount, projectNames, distinctProjectCount, projectNameLimit, remainingProjectCount.

Read every caveat before interpreting a figure. See methodology on how to communicate caveats and data-quality conditions.

Example call

{
  "name": "get_abr_trend",
  "arguments": {}
}

Add account with an identifier from list_accounts; omit it only when the connection reaches exactly one account.