Content
getPinnedItems
API
My Account
- Overview
- GETGetAuthenticatedUser
- POSTRegisterUser
- PUTCreateEmailOneTimePasscode
- GETGetEmailVerificationStatus
- GETListMyAvailableOrganizations
- POSTJoinOrganization
- DELDeleteMe
- GETcreateWarehouseCredentials
- POSTupdateWarehouseCredentials
- DELdeleteWarehouseCredentials
- PATCHupdateWarehouseCredentials
- GETgetLoginOptions
- PATCHRotate personal access token
Organizations
- Overview
- GETGetMyOrganization
- PUTCreateOrganization
- PATCHUpdateMyOrganization
- DELDeleteMyOrganization
- GETListOrganizationProjects
- GETListOrganizationMembers
- GETGetOrganizationMemberByUuid
- DELDeleteOrganizationMember
- GETListOrganizationEmailDomains
- PATCHUpdateOrganizationEmailDomains
- GETListGroupsInOrganization
- POSTCreateGroupInOrganization
Projects
- Overview
- GETGetExplores
- PUTSetExplores
- GETGetExplore
- POSTCompileQuery
- POSTDownloadCsvFromExplore
- GETGetProject
- GETListChartsInProject
- GETListChartSummariesInProject `Deprecated`
- GETListSpacesInProject
- GETGetProjectAccessList
- POSTCalculateTotalFromQuery
- GETgetUserWarehouseCredentialsPreference
- PATCHupdateUserWarehouseCredentialsPreference
- GETgetCustomMetrics
- PATCHupdateProjectMetadata
- DELdeleteProjectSemanticLayerConnection
- PATCHupdateProjectSemanticLayerConnection
- GETgetDashboards
- POSTcreateDashboard
- PATCHupdateDashboards
- POSTcreatePreview
- PATCHPatch apiv1projects schedulersettings
- GETgetTags
- POSTcreateTag
- DELdeleteTag
- PATCHupdateTag
- GETgetChartsAsCode
- GETgetDashboardsAsCode
- POSTupsertChartAsCode
- POSTupsertDashboardAsCode
- GETGetLatestValidationResults
- POSTValidateProject
- DELDeleteValidationDismiss
Roles & Permissions
- PATCHUpdateOrganizationMember
- POSTCreateSpaceInProject
- GETGet apiv1projects access
- POSTGetProjectAccessList
- GETGetProjectMemberAccess
- DELRevokeProjectAccessForUser
- PATCHGrantProjectAccessToUser
- PATCHUpdateSpace
- POSTAddSpaceUserAccess
- DELRevokeSpaceAccessForUser
- POSTAddSpaceGroupAccess
- DELRevokeGroupSpaceAccess
Catalog
- GETgetCatalog
- GETgetMetadata
- GETgetAnalytics
- GETgetAnalyticsField
- GETgetMetricsCatalog
- GETgetMetric
- GETgetMetricsWithTimeDimensions
- GETgetSegmentDimensions
- POSTaddCategoryToCatalogItem
- DELremoveCategoryFromCatalogItem
- PATCHupdateCatalogItemIcon
- GETgetMetricsTree
- POSTcreateMetricsTreeEdge
- DELdeleteMetricsTreeEdge
Exports
Git Integration
User Groups
Metrics Explorer
Notifications
Charts
Schedulers
Share links
SSH Keypairs
Content
getPinnedItems
Get pinned items
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
pinned-lists
/
{pinnedListUuid}
/
items
{
"results": [
{
"category": "mostPopular",
"data": {
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceUuid": "<string>",
"pinnedListUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"views": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"pinnedListOrder": 123,
"validationErrors": [
{
"validationId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
},
"type": "dashboard"
}
],
"status": "ok"
}
Path Parameters
project uuid
the list uuid for the pinned items
Response
200
application/json
Success
From T, pick a set of properties whose keys are in the union K
Available options:
dashboard
Available options:
mostPopular
, recentlyUpdated
, pinned
Available options:
ok
{
"results": [
{
"category": "mostPopular",
"data": {
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceUuid": "<string>",
"pinnedListUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"views": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"pinnedListOrder": 123,
"validationErrors": [
{
"validationId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
},
"type": "dashboard"
}
],
"status": "ok"
}