In this article, you will find the overview of endpoints available for API components.

API cards endpoints

Below, you will find the API endpoints for the API Card component.

For more information on parameters, see API components filter. For the full list of supported parameters per API endpoint, refer to our API documentation.

Enum keyDescriptionAllowed parameters
api/dashboard/applicationsReturns a list of applications."applicationId" "applicationIds" "includeRelationsId" "includeSubspaces" "includeUserRelationIds" "languageCode" "name" "spaceId"
api/dashboard/dashboard/{parentPageEnumKey}Returns a list of dashboards.
api/dashboard/favouritesReturns a list of objects that the user has in “favorites”.
api/dashboard/filtered-objectReturns a list of objects based on filter.
api/dashboard/filtered-root-objectReturns a list of objects based on filter.
api/dashboard/spacesReturns a list of spaces.
api/dashboard/recentReturns a list of objects that the user has recently viewed."additionalObjectRelations" "additionalUserRelations" "facets": [ { ... } ] "favouriteObjectTypes" "formId" "fulltextSearchId" "languageCode" "lastSelectedFacet" "offset" "searchFilter": [ { ... } ] "size" "sort": { ... } "useSimpleQueryOnly"
api/dashboard/recommendedReturns a list of objects recommended for the user based on the search algorithm.N/A
api/mr-object/recommendations/customizable-overview-filterReturns a list of recommended objects based on filter."additionalAttributes" "additionalObjectRelations" "additionalUserRelations" "applicationId" "applicationIds" "applicationName" "attributeValues": {...}, "created" "creatorColorHex" "creatorId" "creatorName" "currentUserRelationIds": [...], "objectName" "objectRelationValues": {...}, "objectTypeId" "objectTypeIds": [...], "objectTypeName" "parentObjectId" "path" "sourceObjectId" "spaceId" "spaceIds": [...], "spaceName" "statusId" "statusIds": [...], "statusName" "updated" "updaterColorHex" "updaterId" "updaterName" "userRelationValues": {...}

API charts and summaries endpoints

Below you will find all API endpoints that are available for API Charts and Summaries.

Tip

Enterprise customers can request special API endpoints for their data. For more information, contact our Customer Success team.

Endpoint format

Charts and summaries use the same statistics API, but different endpoints.

Charts call:

  •   https://help.dawiso.com/api/chart/statistics/{enum_key}/buckets

Summaries call:

  •   https://help.dawiso.com/api/chart/statistics/{enum_key}/single

Replace enum_key with one of the values in the table below.

Suported enum keys

Enum keyDescriptionMandatory parameters
core_data_model_domains_coverageReturns the counts of data model domains within a specified space and application.spaceId, applicationId
core_chart_number_object_type_by_space_appReturns the counts of objects grouped by object type within a specified space and application.spaceId, applicationId, objectTypeId
core_chart_number_objects_by_workflow_stateReturns the counts of objects grouped by workflow state (e.g., Draft, In review, Approved).spaceId, applicationId, workflowStateKey
core_chart_number_user_object_relation_by_space_appReturns the counts of user-object relations (e.g., owner, steward, requester) from a specified space and application.spaceId, applicationId, userRelationTypeId
core_statistic_chart_business_assets_trendReturns a time series of the counts of business assets (e.g. business terms, KPIs, business definitions) over time. Components using this endpoint must be connected to a time selector.date_valid
core_statistic_chart_documentation_assets_trendReturns a time series of the counts of documentation assets (e.g. documentation pages, diagrams) over time. Components using this endpoint must be connected to a time selector.date_valid
core_statistic_chart_instate_durationReturns statistics on how long objects have been in selected workflow states, filtered by user-object relations to the current user.workflowStateKeys, userRelationTypeId, currentUser
core_statistic_chart_number_app_objectsReturns the number of objects in an application.applicationId
core_statistic_chart_number_business_assets[Summaries-only] Returns the total number of business assets.
core_statistic_chart_number_documentation_assets[Summaries-only] Returns the total number of documentation assets.
core_statistic_chart_number_instate_objectsReturns the number of objects currently in specified workflow state.userRelationTypeId, workflowStateKey, currentUser
core_statistic_chart_number_objectsReturns the number of objects that are in the selected workflow state, filtered by user-object relations to the current user.userRelationTypeId, workflowStateKey, currentUser
core_statistic_chart_number_power_usersReturns the number of power users (users who meet defined activity criteria such as frequent edits or visits).
core_statistic_chart_number_related_objectsReturns the number of objects in a relation from a specified space and application.spaceId, applicationId
core_statistic_chart_number_reports_and_dashboardsReturns the number of reports and dashboards.
core_statistic_chart_number_technical_assets[Summaries-only] Returns the total number of technical assets (e.g., tables, views, columns).
core_statistic_chart_number_total_objects[Summaries-only] Returns the total number of objects across the entire environment (global count, used as a high-level KPI).
core_statistic_chart_number_total_spaces[Summaries-only] Returns the total number of spaces in the instance.
core_statistic_chart_number_total_users[Summaries-only] Returns the total number of users.
core_statistic_chart_number_user_object_relation_total[Summaries-only] Returns the total number of objects to which the current user has a relation (e.g., the total number of objects where the user is an owner).userRelationTypeId, currentUser
core_statistic_chart_number_visited_pagesReturns the number of visited pages recorded in usage analytics. Components using this endpoint must be connected to a time selector.date_valid
core_statistic_chart_objects_bytypeReturns counts of objects grouped by object type (business term, technical table, report, etc.) across the instance.objectTypeId
core_statistic_chart_objects_statesReturns counts of objects grouped by workflow state for all objects across the instance.workflowStateKey
core_statistic_chart_objects_states_urReturns counts of objects grouped by workflow state, filtered by user-object relations to the current user (for example, number of Draft objects where the current user is steward).userRelationTypeId, workflowStateKey, currentUser
core_statistic_chart_reports_and_dashboards_trendReturns a time series of the number of reports and dashboards over time. Components using this endpoint must be connected to a time selector.date_valid
core_statistic_chart_technical_assets_trendReturns a time series of the number of technical assets over time. Components using this endpoint must be connected to a time selector.date_valid

API tables endpoints

In the table below, you can find endpoints for the API Table component.

For more information on parameters, see API components filter. For the full list of supported parameters per API endpoint, refer to our API documentation.

Enum keyDescriptionAllowed parameters
api/mr-comment/customizable-overview-filterA universal API that returns information on comments and their authors.Most often used filters: spaceId, applicationId, currentUserRelationTypeKeys
api/mr-object/customizable-overview-filterA universal API that returns any object data, including its attributes, relations, and user relations.Most often used filters: spaceId, applicationId, parentObjectId, currentUserRelationTypeKeys
api/mr-object-relation/customizable-overview-filterA universal API that returns any data of the target object in a relation, including its attributes, relations, and user relations.Most often used filters: objectId, relationTypeKeys
/api/sql-external/tableEnables access to external tables backed by custom data sources using extraRequestData and externalKey columns. Data sources can be defined by the client from existing API endpoints, or created on request by our Customer Success team.Most often used filters: spaceId, applicationId