MYmyaltimate
TEAMS

Get Cost Period Comparison

Changed on
get/teams/cost/period-comparison

Request

  • Base URL
    https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.myaltimate.com/teams/cost/period-comparison
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

start_datestring
end_datestring
pageinteger

Page number

page_sizeinteger
teamsstring[]
instance_idstring
order_by'cost' | 'percentage_spend' | 'percentage_change_from_previous_period'

Order by: cost, percentage_spend, percentage_change_from_previous_period

order_direction'asc' | 'desc'

Order direction: asc, desc

sizeinteger

Page size

Headers

x-tenantstring required

Response

Successful Response

totalinteger nullable required
pageinteger nullable required
sizeinteger nullable required
pagesinteger nullable

Changes

  • 77a7dface13fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 8a08bdb37cfaRevision changes
    • breaking

      the query request parameter order_by was restricted to a list of enum values

    • breaking

      the query request parameter order_direction was restricted to a list of enum values

    • info

      added the new enum value asc to the query request parameter order_direction

    • info

      added the new enum value cost to the query request parameter order_by

    • info

      added the new enum value desc to the query request parameter order_direction

    • info

      added the new enum value percentage_change_from_previous_period to the query request parameter order_by

    • info

      added the new enum value percentage_spend to the query request parameter order_by