Power BI REST API functions

This page assumes you know how to use the Power Query editor and how to find the Cognite Data Fusion (CDF) API endpoint and request body you need. See the Cognite API introduction.

GetCDF

Use this function to fetch data from Cognite APIs using the HTTP GET method. The function auto-paginates CDF until the request cursor is exhausted. For optimal performance, see the Cognite API specifications for endpoints that support this HTTP method and the maximum supported page size for each endpoint.

Parameter	Type	Description
`url`	Text	The URL path to make the request, starting directly after the project name. For example, `"/models/views"`, `"/models/spaces"`.

PostCDF

Use this function to fetch data from Cognite APIs using the HTTP POST method. The function auto-paginates CDF until the request cursor is exhausted. For optimal performance, see the Cognite API specifications for endpoints that support this HTTP method.

Parameter	Type	Description
`url`	Text	The URL path to make the request, starting directly after the project name. For example, `"/models/instances/list"`, `"/timeseries/data/list"`.
`body`	Text	A text representation of the JSON body to send with the request. For example, `"{}"`, `"{""limit"": 1000}"`. When available, set the `limit` parameter to the maximum supported value for the endpoint. For optimal performance, see the Cognite API specifications. When invoking this function with Power BI, the query is presented as a multiline text area. Enter JSON directly in that field. In M code, escape a double quote as `""`, or use `Text.FromBinary(Json.FromValue(...))`. If you provide an invalid JSON body, the function returns an error of type `CogniteConnectorError`.

The PostCDF function offers auto-pagination for simple requests that expect a cursor field (string) at the top level of the request body. For more complex requests, write a custom pagination logic using the Power Query M language. See Power Query functions and example queries.

GraphQL

Use this function to fetch data from a CDF data model using GraphQL.

Parameter	Type	Description
`space`	Text	The external ID of the data model space.
`datamodel`	Text	The external ID of the data model.
`version`	Text	The version of the data model.
`query`	Text	A text representation of the GraphQL query to send when making the request. Include `after:$cursor and pageInfo { hasNextPage endCursor }` in the query to enable auto-pagination. Consider setting the `first` parameter to 1000 (maximum supported limit) for optimal performance. For example, `"query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}"`. When invoking this function with Power BI, the query is presented as a multiline text area. You don’t need to escape double quote characters. If you provide an invalid GraphQL query, the function returns an error of type `CogniteAPIError`.
`variables`	Text (optional)	A text representation of the JSON variables to send when making the request. For example, `"{""country"": ""Norway""}"`. Don’t include the `cursor` variable in the `variables` parameter, since this is automatically managed by the connector. If you provide an invalid JSON body, the function returns an error of type `CogniteConnectorError`.

The GraphQL function offers auto-pagination for GraphQL queries that include only one query expression with one pagination target, identified by the after: $cursor and pageInfo { hasNextPage endCursor } fields.For more complex queries, write a custom pagination logic using the Power Query M language. See Power Query functions and example queries. Always test the queries and variables in Power BI with CDF Query Explorer to ensure they’re correct.

ODataCDF

Use this function to fetch data from the data modeling OData service by URL path. Set apiVersion to "20230821". If you omit it, the function uses "v1", the asset-centric OData service, which is deprecated. Move existing v1 queries to the data modeling OData service. To read a data model without building the path yourself, use ODataDataModel.

Parameter	Type	Description
`url`	Text	The URL path starting from the project name only. Do not include the cluster or full URL - the connector handles this automatically. For example, `"publicdata/models/spaces/cdf_cdm/datamodels/CogniteCore/versions/v1"` for the `CogniteCore` data model in the `publicdata` project. Note: This differs from the full OData URL format used in other clients. For guidance on constructing OData query paths and available endpoints, see the OData Services documentation.
`apiVersion`	Text (optional)	The API version of the OData service to use with the request. Set this to `"20230821"`, the latest version of the data modeling OData service. Defaults to `"v1"`, the deprecated asset-centric OData service.

ODataDataModel

Use this function to fetch data from a CDF data model using the data modeling OData service.

Parameter	Type	Description
`space`	Text	The external ID of the data model space.
`datamodel`	Text	The external ID of the data model.
`version`	Text	The version of the data model.
`apiVersion`	Text (optional)	The API version of the OData service to use when making the request. The default value is `"20230821"`. The latest version of the data modeling OData service is `"20230821"`.

​GetCDF

​PostCDF

​GraphQL

​ODataCDF

​ODataDataModel

GetCDF

PostCDF

GraphQL

ODataCDF

ODataDataModel