S365 BI API (1.1.0)

API for querying S365 data from SmarterDS

Facts

Fact table endpoints

Get Collection Facts

Get collection fact records

query Parameters

	Customer (integer) or Customer (null) (Customer) Customer surrogate key for filtering
	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

	Area Sk (integer) or Area Sk (null) (Area Sk)
collection_sk required	integer (Collection Sk)
	Container Sk (integer) or Container Sk (null) (Container Sk)
	Customer Sk (integer) or Customer Sk (null) (Customer Sk)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
datestamp required	string (Datestamp)
	Dekit Site Sk (integer) or Dekit Site Sk (null) (Dekit Site Sk)
	Site Sk (integer) or Site Sk (null) (Site Sk)
starttime required	string (Starttime)
	User Sk (integer) or User Sk (null) (User Sk)
weight required	number (Weight)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/facts/collection" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422
500

Content type

application/json

[{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Collection Facts Query

Start an asynchronous query for collection fact records

query Parameters

	Customer (integer) or Customer (null) (Customer) Customer surrogate key for filtering
	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/facts/collection/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Collection Facts Status

Get the status and results of an asynchronous collection facts query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/facts/collection/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
404
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Dimensions

Dimension table endpoints

Get Area Dimensions

Get area dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

area_sk required	integer (Area Sk)
areaname required	string (Areaname)
arearef required	string (Arearef)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/area" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422
500

Content type

application/json

[{"area_sk": 130,
"areaname": "21 - Edinburgh",
"arearef": "JLP25",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Area Dimensions Query

Start an asynchronous query for area dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/area/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Area Dimensions Status

Get the status and results of an asynchronous area dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/area/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Customer Dimensions

Get customer dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

customer_sk required	integer (Customer Sk)
customername required	string (Customername)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
dekitmethod required	string (Dekitmethod)
subdomain required	string (Subdomain)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/customer" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"customer_sk": 6,
"customername": "Biffa",
"dekitmethod": "app",
"subdomain": "biffa",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Customer Dimensions Query

Start an asynchronous query for customer dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/customer/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Customer Dimensions Status

Get the status and results of an asynchronous customer dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/customer/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Container Dimensions

Get container dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

container_sk required	integer (Container Sk)
containername required	string (Containername)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/container" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"container_sk": 101,
"containername": "1100L General Waste",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Container Dimensions Query

Start an asynchronous query for container dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/container/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Container Dimensions Status

Get the status and results of an asynchronous container dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/container/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Issuereference Dimensions

Get issue reference dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
iscontaminated required	boolean (Iscontaminated)
issuename required	string (Issuename)
issueref required	string (Issueref)
issuereference_sk required	integer (Issuereference Sk)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/issuereference" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"iscontaminated": true,
"issuename": "Contamination",
"issueref": "CONT01",
"issuereference_sk": 456,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Issuereference Dimensions Query

Start an asynchronous query for issue reference dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/issuereference/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Issuereference Dimensions Status

Get the status and results of an asynchronous issue reference dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/issuereference/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Level Dimensions

Get level dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
level required	string (Level)
level_sk required	integer (Level Sk)
	Position (integer) or Position (null) (Position)
type required	string (Type)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/level" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"level": "Level 1",
"level_sk": 789,
"position": 1,
"type": "Standard",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Level Dimensions Query

Start an asynchronous query for level dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/level/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Level Dimensions Status

Get the status and results of an asynchronous level dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/level/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Media Dimensions

Get media dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

archive required	boolean (Archive)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
datestamp required	string (Datestamp)
media_sk required	integer (Media Sk)
mediatypes required	string (Mediatypes)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/media" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"archive": false,
"datestamp": "2025-01-22 14:30:15",
"media_sk": 234,
"mediatypes": "image/jpeg",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Media Dimensions Query

Start an asynchronous query for media dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/media/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Media Dimensions Status

Get the status and results of an asynchronous media dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/media/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Region Dimensions

Get region dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
region_sk required	integer (Region Sk)
regionname required	string (Regionname)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/region" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"region_sk": 345,
"regionname": "South East",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Region Dimensions Query

Start an asynchronous query for region dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/region/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Region Dimensions Status

Get the status and results of an asynchronous region dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/region/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Site Dimensions

Get site dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

archive required	boolean (Archive)
bdmname required	string (Bdmname)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
email required	string (Email)
ip required	string (Ip)
opsmanager required	string (Opsmanager)
pollingrequired required	boolean (Pollingrequired)
polltime required	string (Polltime)
postcode required	string (Postcode)
site_sk required	integer (Site Sk)
sitename required	string (Sitename)
siteref required	string (Siteref)
sitetype required	string (Sitetype)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/site" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"archive": false,
"bdmname": "Jane Doe",
"email": "jane.doe@domain.com",
"ip": "192.168.1.100",
"opsmanager": "John Smith",
"pollingrequired": false,
"polltime": "08:00",
"postcode": "BN1 1AB",
"site_sk": 567,
"sitename": "Waitrose Brighton",
"siteref": "WTR001",
"sitetype": "Retail",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Site Dimensions Query

Start an asynchronous query for site dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/site/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Site Dimensions Status

Get the status and results of an asynchronous site dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/site/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get User Dimensions

Get user dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

archive required	boolean (Archive)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
email required	string (Email)
fullname required	string (Fullname)
logindisabled required	boolean (Logindisabled)
user_sk required	integer (User Sk)
username required	string (Username)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/user" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"archive": false,
"email": "john.smith@domain.com",
"fullname": "John Smith",
"logindisabled": false,
"user_sk": 789,
"username": "jsmith",
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start User Dimensions Query

Start an asynchronous query for user dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/user/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get User Dimensions Status

Get the status and results of an asynchronous user dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/user/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Wastereference Dimensions

Get waste reference dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
wastename required	string (Wastename)
wasteref required	integer (Wasteref)
wastereference_sk required	integer (Wastereference Sk)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/wastereference" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

[{"wastename": "General Waste",
"wasteref": 1001,
"wastereference_sk": 890,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Wastereference Dimensions Query

Start an asynchronous query for waste reference dimension records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/wastereference/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Wastereference Dimensions Status

Get the status and results of an asynchronous waste reference dimensions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/dimensions/wastereference/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Junctions

Junction table endpoints

Get Collection Issuereference Junctions

Get collection-issue reference junction records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

collection_sk required	integer (Collection Sk)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
issuereference_sk required	integer (Issuereference Sk)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_issuereference" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422
500

Content type

application/json

[{"collection_sk": 123,
"issuereference_sk": 456,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Collection Issuereference Junctions Query

Start an asynchronous query for collection-issue reference junction records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_issuereference/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Collection Issuereference Junctions Status

Get the status and results of an asynchronous collection-issue reference junctions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_issuereference/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Collection Media Junctions

Get collection-media junction records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

collection_sk required	integer (Collection Sk)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
media_sk required	integer (Media Sk)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_media" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422
500

Content type

application/json

[{"collection_sk": 123,
"media_sk": 456,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Collection Media Junctions Query

Start an asynchronous query for collection-media junction records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_media/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Collection Media Junctions Status

Get the status and results of an asynchronous collection-media junctions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_media/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

Get Collection Wastereference Junctions

Get collection-waste reference junction records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

Array

collection_sk required	integer (Collection Sk)
required	object (DataLakeFields) Mixin for common data lake fields that should appear at the end of each model
wastereference_sk required	integer (Wastereference Sk)

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_wastereference" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422
500

Content type

application/json

[{"collection_sk": 123,
"wastereference_sk": 456,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]

Start Collection Wastereference Junctions Query

Start an asynchronous query for collection-waste reference junction records

query Parameters

	Since (string) or Since (null) (Since) Start of time window (ISO8601). Filters records from this timestamp onwards.
	Until (string) or Until (null) (Until) End of time window (ISO8601). Filters records up to and including this timestamp.

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_wastereference/async" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "RUNNING",
"message": "Query execution started"
}

Get Collection Wastereference Junctions Status

Get the status and results of an asynchronous collection-waste reference junctions query

path Parameters

query_id

required

string (Query Id)

Query ID returned from async query endpoint

Responses

Response Schema: application/json

message required	string (Message)
query_id required	string (Query Id)
	Array of Results (objects) or Results (null) (Results)
state required	string (QueryState) Enum: "RUNNING" "SUCCEEDED" "FAILED"

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/junctions/collection_wastereference/status/{query_id}" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200
422

Content type

application/json

{"query_id": "12345678-1234-5678-1234-567812345678",
"state": "SUCCEEDED",
"message": "Query complete",
"results": [{"area_sk": 50,
"collection_sk": 123,
"container_sk": 101,
"customer_sk": 456,
"datestamp": "2025-06-01 12:34:56",
"dekit_site_sk": 789,
"site_sk": 789,
"starttime": "2025-06-01 12:34:56",
"user_sk": 303,
"weight": 75.5,
"datalake": {"datalakeingestutc": "2025-01-22 14:30:15",
"day": 22,
"month": 1,
"year": 2025
}
}
]
}

health

Health Check

Health check endpoint

Responses

Response Schema: application/json

any

Request samples

cURL
Python
JavaScript
Node.js

curl --request GET \
     --url "https://bi.365.smarterds.com/health" \
     --header "x-api-key: YOUR_API_KEY"

Response samples

200

Content type

application/json

null