Allocations

Create an allocation

Creates a new allocation.

post/analytics/v1/allocations

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/analytics/v1/allocations
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Request body

namestring required

Allocation name.

descriptionstring required

Allocation description.

unallocatedCostsstring nullable

Custom label for values that do not fit into allocation (required for group type allocation).

folderIdstring

Identifier of the folder that contains the allocation. Set to "root" if the allocation is at the top level (not in a folder).

Example request

{
  "rule": {
    "formula": "A AND B"
  },
  "rules": [
    {
      "formula": "A AND B"
    }
  ],
  "folderId": "root"
}

Response

OK - The request succeeded.

idstring

Allocation ID.

namestring

Allocation name.

descriptionstring

Allocation description.

typestring

Type of allocation (preset or custom).

allocationType'single' | 'group'

Composition type of allocation.

createTimeinteger

The time when the allocation was created (in UNIX timestamp).

updateTimeinteger

Last time the allocation was modified (in UNIX timestamp).

anomalyDetectionboolean nullable

Whether anomaly detection is enabled for this allocation.

unallocatedCostsstring nullable

Custom label for values that do not fit into allocation (required for group type allocation).

folderIdstring

Identifier of the folder that contains the allocation. Set to "root" if the allocation is at the top level (not in a folder).

Example response

{
  "rule": {
    "formula": "A AND B"
  },
  "rules": [
    {
      "formula": "A AND B"
    }
  ],
  "folderId": "root"
}

Changes

No recorded changes to this operation across all 1 revision of this API.