> For the complete documentation index, see [llms.txt](https://docs.soda.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.soda.io/apis/rest-api/data-products.md).

# Data Products

Soda Cloud API Data Product Endpoints

## List data product access requests

> This endpoint allows you to list the requests for access to datasets of data products, newest first.\
> \
> This GET is a paginated API that uses the following parameters to request specific details:\
> \
> \- \`cursor\`: Omit for the first page. Pass the previous response's \`nextCursor\`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\
> \
> \- \`size\`: Number of items per page, from 1 to 100, default 10. The size may change between pages.\
> \
> \- \`dataProductId\`: Optionally, list only the requests of one data product.\
> \
> \- \`status\`: Optionally, list only the requests with this status: \`pending\`, \`approved\` or \`declined\`.\
> \
> \- \`requesterUserId\`: Optionally, list only the requests of one user. Pass your own user id to list your own requests.\
> \
> \- \`needsMyReview\`: Optionally, set to \`true\` to list only the pending requests of the data products on which you have \*\*Manage permissions\*\* permission, so the ones you can approve or decline in Soda Cloud.\
> \
> The response contains \`content\` and, when more items are available, \`nextCursor\`. An absent \`nextCursor\` marks the end of the results. Page numbers and totals are not returned.\
> \
> \## Authorization\
> \
> You see your own requests, and the requests of the data products on which you have \*\*Manage permissions\*\* permission. Users with \*\*Manage organization settings\*\* permission see every request. The filters can only narrow this down.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 60 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"DataProductAccessRequestStatusContentDTO":{"type":"string","enum":["pending","approved","declined"]},"PublicApiListDataProductAccessRequestsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataProductAccessRequestContentDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"DataProductAccessRequestContentDTO":{"type":"object","properties":{"cloudUrl":{"type":"string","description":"Link to the data product in Soda Cloud."},"created":{"type":"string","format":"date-time"},"credentialsGiven":{"type":"boolean","description":"Whether an approver noted that credentials for the dataset were given to the requester. A note only: it changes no access."},"dataProductId":{"type":"string"},"dataProductName":{"type":"string","description":"The `name` of the data product, which is the `key` of its YAML."},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"decidedAt":{"type":"string","format":"date-time","description":"When the request was approved or declined. Absent while the request is pending."},"id":{"type":"string"},"status":{"type":"object","$ref":"#/components/schemas/DataProductAccessRequestStatusContentDTO"}},"required":["cloudUrl","created","credentialsGiven","dataProductId","datasetId","id","status"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProductAccessRequests":{"get":{"description":"This endpoint allows you to list the requests for access to datasets of data products, newest first.\n\nThis GET is a paginated API that uses the following parameters to request specific details:\n\n- `cursor`: Omit for the first page. Pass the previous response's `nextCursor`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\n\n- `size`: Number of items per page, from 1 to 100, default 10. The size may change between pages.\n\n- `dataProductId`: Optionally, list only the requests of one data product.\n\n- `status`: Optionally, list only the requests with this status: `pending`, `approved` or `declined`.\n\n- `requesterUserId`: Optionally, list only the requests of one user. Pass your own user id to list your own requests.\n\n- `needsMyReview`: Optionally, set to `true` to list only the pending requests of the data products on which you have **Manage permissions** permission, so the ones you can approve or decline in Soda Cloud.\n\nThe response contains `content` and, when more items are available, `nextCursor`. An absent `nextCursor` marks the end of the results. Page numbers and totals are not returned.\n\n## Authorization\n\nYou see your own requests, and the requests of the data products on which you have **Manage permissions** permission. Users with **Manage organization settings** permission see every request. The filters can only narrow this down.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"GET/api/v1/dataProductAccessRequests","parameters":[{"in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"dataProductId","schema":{"type":"string"}},{"in":"query","name":"needsMyReview","schema":{"type":"boolean"}},{"in":"query","name":"requesterUserId","schema":{"type":"string"}},{"in":"query","name":"size","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"status","schema":{"type":"object","$ref":"#/components/schemas/DataProductAccessRequestStatusContentDTO"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiListDataProductAccessRequestsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List data product access requests","tags":["Data Products"]}}}}
```

## Request access to a dataset of a data product

> This endpoint allows you to ask for access to a dataset that is an output of a data product.\
> \
> The body has the \`dataProductId\`, the \`datasetId\` of the dataset output, and optionally a \`purpose\` of at most 1000 characters that tells the reviewer why you need the data.\
> \
> The request does not give access. A user who can manage the permissions of the data product approves or declines it in Soda Cloud. Use \`GET /api/v1/dataProductAccessRequests/{accessRequestId}\` to follow its \`status\`.\
> \
> While you have a pending request for the same dataset of the same data product, no new request is made: the pending request is returned, also when the \`purpose\` differs.\
> \
> An unknown data product returns 400 with the code \`data\_product\_not\_found\`. A dataset that is not an output of the data product returns 400 with the code \`data\_product\_output\_not\_found\`. If you can already view the dataset, the request is rejected with a 400 error and the code \`dataset\_access\_already\_granted\`.\
> \
> \## Authorization\
> \
> Only a person can ask for access, so the API key must belong to a user. The API key of a service account is rejected with a 403 error and the code \`invalid\_user\_type\`. You must have \*\*View data product\*\* permission on the data product; without it, the request is rejected with a 403 error.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Auditable\
> \
> This API is marked as \*\*audited\*\* on execution.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 100 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiCreateDataProductAccessRequestRequestDTO":{"type":"object","properties":{"dataProductId":{"type":"string"},"datasetId":{"type":"string"},"purpose":{"type":"string"}},"required":["dataProductId","datasetId"]},"PublicApiCreateDataProductAccessRequestResponse":{"type":"object","properties":{"accessRequest":{"type":"object","$ref":"#/components/schemas/DataProductAccessRequestContentDTO"}},"required":["accessRequest"]},"DataProductAccessRequestContentDTO":{"type":"object","properties":{"cloudUrl":{"type":"string","description":"Link to the data product in Soda Cloud."},"created":{"type":"string","format":"date-time"},"credentialsGiven":{"type":"boolean","description":"Whether an approver noted that credentials for the dataset were given to the requester. A note only: it changes no access."},"dataProductId":{"type":"string"},"dataProductName":{"type":"string","description":"The `name` of the data product, which is the `key` of its YAML."},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"decidedAt":{"type":"string","format":"date-time","description":"When the request was approved or declined. Absent while the request is pending."},"id":{"type":"string"},"status":{"type":"object","$ref":"#/components/schemas/DataProductAccessRequestStatusContentDTO"}},"required":["cloudUrl","created","credentialsGiven","dataProductId","datasetId","id","status"]},"DataProductAccessRequestStatusContentDTO":{"type":"string","enum":["pending","approved","declined"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProductAccessRequests":{"post":{"description":"This endpoint allows you to ask for access to a dataset that is an output of a data product.\n\nThe body has the `dataProductId`, the `datasetId` of the dataset output, and optionally a `purpose` of at most 1000 characters that tells the reviewer why you need the data.\n\nThe request does not give access. A user who can manage the permissions of the data product approves or declines it in Soda Cloud. Use `GET /api/v1/dataProductAccessRequests/{accessRequestId}` to follow its `status`.\n\nWhile you have a pending request for the same dataset of the same data product, no new request is made: the pending request is returned, also when the `purpose` differs.\n\nAn unknown data product returns 400 with the code `data_product_not_found`. A dataset that is not an output of the data product returns 400 with the code `data_product_output_not_found`. If you can already view the dataset, the request is rejected with a 400 error and the code `dataset_access_already_granted`.\n\n## Authorization\n\nOnly a person can ask for access, so the API key must belong to a user. The API key of a service account is rejected with a 403 error and the code `invalid_user_type`. You must have **View data product** permission on the data product; without it, the request is rejected with a 403 error.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Auditable\n\nThis API is marked as **audited** on execution.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/dataProductAccessRequests","requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateDataProductAccessRequestRequestDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateDataProductAccessRequestResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Request access to a dataset of a data product","tags":["Data Products"]}}}}
```

## Get a data product access request

> This endpoint allows you to retrieve a request for access to a dataset of a data product, with its \`status\`.\
> \
> \`accessRequestId\` is the \`id\` that \`POST /api/v1/dataProductAccessRequests\` returned.\
> \
> An unknown id returns 404 with the code \`data\_product\_access\_request\_not\_found\`. So does the id of a request that you are not allowed to see.\
> \
> \## Authorization\
> \
> You can see your own requests, and the requests of the data products on which you have \*\*Manage permissions\*\* permission. Users with \*\*Manage organization settings\*\* permission can see every request.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 1000 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiGetDataProductAccessRequestResponse":{"type":"object","properties":{"accessRequest":{"type":"object","$ref":"#/components/schemas/DataProductAccessRequestContentDTO"}},"required":["accessRequest"]},"DataProductAccessRequestContentDTO":{"type":"object","properties":{"cloudUrl":{"type":"string","description":"Link to the data product in Soda Cloud."},"created":{"type":"string","format":"date-time"},"credentialsGiven":{"type":"boolean","description":"Whether an approver noted that credentials for the dataset were given to the requester. A note only: it changes no access."},"dataProductId":{"type":"string"},"dataProductName":{"type":"string","description":"The `name` of the data product, which is the `key` of its YAML."},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"decidedAt":{"type":"string","format":"date-time","description":"When the request was approved or declined. Absent while the request is pending."},"id":{"type":"string"},"status":{"type":"object","$ref":"#/components/schemas/DataProductAccessRequestStatusContentDTO"}},"required":["cloudUrl","created","credentialsGiven","dataProductId","datasetId","id","status"]},"DataProductAccessRequestStatusContentDTO":{"type":"string","enum":["pending","approved","declined"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProductAccessRequests/{accessRequestId}":{"get":{"description":"This endpoint allows you to retrieve a request for access to a dataset of a data product, with its `status`.\n\n`accessRequestId` is the `id` that `POST /api/v1/dataProductAccessRequests` returned.\n\nAn unknown id returns 404 with the code `data_product_access_request_not_found`. So does the id of a request that you are not allowed to see.\n\n## Authorization\n\nYou can see your own requests, and the requests of the data products on which you have **Manage permissions** permission. Users with **Manage organization settings** permission can see every request.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n1000 requests/60 seconds","operationId":"GET/api/v1/dataProductAccessRequests/{accessRequestId}","parameters":[{"in":"path","name":"accessRequestId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiGetDataProductAccessRequestResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get a data product access request","tags":["Data Products"]}}}}
```

## List data products

> This endpoint allows you to list the data products in your organization.\
> \
> This GET is a paginated API that uses the following parameters to request specific details:\
> \
> \- \`cursor\`: Omit for the first page. Pass the previous response's \`nextCursor\`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\
> \
> \- \`size\`: Number of items per page, from 1 to 1000, default 10. The size may change between pages.\
> \
> \- \`name\`: Optionally, return only the data product whose \`name\` is exactly this value. The match is case-sensitive, so the result has one item or none. Spaces around the value are removed. A blank value returns 400. Leave the parameter out to list all data products. Use it to find the \`id\` of a data product from its name. To publish many data products, list them once without \`name\` and keep their ids.\
> \
> \- \`search\`: Optionally, use this parameter to search the data product label and name.\
> \
> \- \`ownerId\`: Optionally, use this parameter to list only the data products owned by one user or one user group. Supply a single id: either a user id or a user group id. A user id also matches the data products owned by a user group that the user belongs to.\
> \
> \- \`datasetId\`: Optionally, use this parameter to list only the data products that have the dataset as an input.\
> \
> \- \`domain\`: Optionally, use this parameter to list only the data products of one domain. Supply the \`name\` of the domain, which is the \`domain\` value of the data product YAML. The name has at most 64 characters and must be lowercase letters and digits separated by single - or \_, starting with a letter; true, false, null, yes, no, on, off, y, n and base are reserved. An unknown name returns 400 \`domain\_not\_found\`. A domain with no data products that you can view gives an empty page. Data products without a domain never match.\
> \
> \- \`outputType\`: Optionally, use this parameter to list only the data products that have at least one output of the type: \`dataset\` or \`dashboard\`. Supply several types as a comma-separated list or as a repeated parameter; a data product matches when it has an output of any of them.\
> \
> \- \`sort\`: Optionally, sort the results by \`label\` (default) or \`name\`.\
> \
> The \`name\` of a data product is the \`key\` of its YAML, and the \`label\` is the YAML \`name\`.\
> \
> The response contains \`content\` and, when more items are available, \`nextCursor\`. An absent \`nextCursor\` marks the end of the results. Page numbers and totals are not returned.\
> \
> Inputs are not part of the data product. Use \`/api/v1/dataProducts/{dataProductId}/inputs\`, which is paged.\
> \
> Outputs are not part of the data product. Use \`/api/v1/dataProducts/{dataProductId}/outputs\`, which is paged.\
> \
> \## Authorization\
> \
> Only the data products that the user has \*\*View data product\*\* permission on are returned. Soda Cloud Admins have every data product permission on every data product.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 60 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"DataProductOutputTypeContentDTO":{"type":"string","enum":["dataset","dashboard"]},"DataProductSortFieldDTO":{"type":"string","enum":["label","name"]},"PublicApiListDataProductsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"domain":{"type":"object","$ref":"#/components/schemas/DataProductDomainContentDTO"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The name of the data product, from the `key` of its YAML. It is unique in the organization and cannot change."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductDomainContentDTO":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","label","name"]},"DataProductHealthContentDTO":{"type":"object","properties":{"checkTotals":{"type":"object","$ref":"#/components/schemas/DataProductCheckTotalsContentDTO","description":"Sums every input of the data product, including the inputs whose dataset the caller cannot view."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"}},"required":["checkTotals","inputs"]},"DataProductCheckTotalsContentDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"inputsWithoutEvidence":{"type":"integer","format":"int32","description":"Inputs on an existing dataset without any check, including the inputs whose dataset the caller cannot view. An input whose checks are all not evaluated is not counted here."},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["failingCount","inputsWithoutEvidence","notEvaluatedCount","passingCount","warningCount"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"linked":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller can view, counted for the caller only. The sum of linked, notFound and noAccess equals the number of inputs."},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only."},"notFound":{"type":"integer","format":"int32"}},"required":["linked","noAccess","notFound"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"type":"string","enum":["user","userGroup"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProducts":{"get":{"description":"This endpoint allows you to list the data products in your organization.\n\nThis GET is a paginated API that uses the following parameters to request specific details:\n\n- `cursor`: Omit for the first page. Pass the previous response's `nextCursor`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\n\n- `size`: Number of items per page, from 1 to 1000, default 10. The size may change between pages.\n\n- `name`: Optionally, return only the data product whose `name` is exactly this value. The match is case-sensitive, so the result has one item or none. Spaces around the value are removed. A blank value returns 400. Leave the parameter out to list all data products. Use it to find the `id` of a data product from its name. To publish many data products, list them once without `name` and keep their ids.\n\n- `search`: Optionally, use this parameter to search the data product label and name.\n\n- `ownerId`: Optionally, use this parameter to list only the data products owned by one user or one user group. Supply a single id: either a user id or a user group id. A user id also matches the data products owned by a user group that the user belongs to.\n\n- `datasetId`: Optionally, use this parameter to list only the data products that have the dataset as an input.\n\n- `domain`: Optionally, use this parameter to list only the data products of one domain. Supply the `name` of the domain, which is the `domain` value of the data product YAML. The name has at most 64 characters and must be lowercase letters and digits separated by single - or _, starting with a letter; true, false, null, yes, no, on, off, y, n and base are reserved. An unknown name returns 400 `domain_not_found`. A domain with no data products that you can view gives an empty page. Data products without a domain never match.\n\n- `outputType`: Optionally, use this parameter to list only the data products that have at least one output of the type: `dataset` or `dashboard`. Supply several types as a comma-separated list or as a repeated parameter; a data product matches when it has an output of any of them.\n\n- `sort`: Optionally, sort the results by `label` (default) or `name`.\n\nThe `name` of a data product is the `key` of its YAML, and the `label` is the YAML `name`.\n\nThe response contains `content` and, when more items are available, `nextCursor`. An absent `nextCursor` marks the end of the results. Page numbers and totals are not returned.\n\nInputs are not part of the data product. Use `/api/v1/dataProducts/{dataProductId}/inputs`, which is paged.\n\nOutputs are not part of the data product. Use `/api/v1/dataProducts/{dataProductId}/outputs`, which is paged.\n\n## Authorization\n\nOnly the data products that the user has **View data product** permission on are returned. Soda Cloud Admins have every data product permission on every data product.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"GET/api/v1/dataProducts","parameters":[{"in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"datasetId","schema":{"type":"string"}},{"in":"query","name":"domain","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"explode":false,"in":"query","name":"outputType","schema":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataProductOutputTypeContentDTO"}},"style":"form"},{"in":"query","name":"ownerId","schema":{"type":"string"}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"size","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","schema":{"type":"object","$ref":"#/components/schemas/DataProductSortFieldDTO"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiListDataProductsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List data products","tags":["Data Products"]}}}}
```

## Create a data product

> This endpoint allows you to create a data product from its YAML definition.\
> \
> The body has one field, \`contents\`, which holds the data product YAML. The YAML can have at most 3145728 characters. Example:\
> \
> \`\`\`yaml\
> kind: data-product\
> key: monthly\_revenue\_report\
> name: Monthly Revenue Report\
> description: >\
> &#x20; Month-end revenue in USD by region and segment, built from closed-won\
> &#x20; opportunities. Feeds the board pack and the revenue dashboard.\
> url: <https://looker.company.com/dashboards/monthly-revenue\\>
> owner:\
> &#x20; type: soda\_user\_group\
> &#x20; id: 7c4b91e2-6d38-4a05-9f12-83b0e6d7a249\
> attributes:\
> &#x20; department: Finance\
> &#x20; business\_function: Revenue reporting\
> &#x20; documentation\_url: <https://docs.company.com/data-products/monthly-revenue\\>
> &#x20; tags:\
> &#x20;   \- board-reporting\
> &#x20;   \- business-critical\
> inputs:\
> &#x20; \- type: dataset\
> &#x20;   dataset: pg/sales\_data/crm/opportunities\
> &#x20; \- type: dataset\
> &#x20;   dataset: pg/sales\_data/crm/accounts\
> &#x20; \- type: dataset\
> &#x20;   dataset: pg/sales\_data/reference/fx\_rates\
> \`\`\`\
> \
> The \`key\` of the YAML becomes the \`name\` of the data product. If another data product already uses this name, the request is rejected with a 400 error and the code \`data\_product\_name\_already\_exists\`. The message gives the \`id\` of that data product, so that you can publish a new version of it with \`POST /api/v1/dataProducts/{dataProductId}\`. If you have no permission to view that other data product, the request is rejected with a 403 error and the code \`access\_denied\` instead, and the message does not include its id.\
> \
> If the YAML does not parse or does not match the schema, the request is rejected with a 400 error and the code \`invalid\_request\`. If it breaks a data product rule (key, owner, domain, attributes, inputs, outputs), the code is \`invalid\_data\_product\`. The message lists each problem on its own line.\
> \
> The \`domain\` of the YAML must be the \`name\` of a domain in the organization. If domains are not enabled for the organization, a new or changed \`domain\` is rejected.\
> \
> A dataset cannot be both an input and an output of the same data product. To add a dataset input or output, you must have permission to view the dataset. An input or output whose dataset is not found is kept, and a warning tells you so.\
> \
> Problems that do not stop the publish are returned in \`warnings\`, one sentence each.\
> \
> \## Authorization\
> \
> Only users with \*\*Create data products\*\* permission can create data products. Without it, the request is rejected with a 403 error. Soda Cloud Admins have every data product permission on every data product.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 100 requests/60 seconds

````json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDataProductRequestDTO":{"type":"object","properties":{"contents":{"type":"string"}},"required":["contents"]},"PublicApiCreateDataProductResponse":{"type":"object","properties":{"dataProduct":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"},"warnings":{"type":"array","items":{"type":"string"}}},"required":["dataProduct","warnings"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"domain":{"type":"object","$ref":"#/components/schemas/DataProductDomainContentDTO"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The name of the data product, from the `key` of its YAML. It is unique in the organization and cannot change."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductDomainContentDTO":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","label","name"]},"DataProductHealthContentDTO":{"type":"object","properties":{"checkTotals":{"type":"object","$ref":"#/components/schemas/DataProductCheckTotalsContentDTO","description":"Sums every input of the data product, including the inputs whose dataset the caller cannot view."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"}},"required":["checkTotals","inputs"]},"DataProductCheckTotalsContentDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"inputsWithoutEvidence":{"type":"integer","format":"int32","description":"Inputs on an existing dataset without any check, including the inputs whose dataset the caller cannot view. An input whose checks are all not evaluated is not counted here."},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["failingCount","inputsWithoutEvidence","notEvaluatedCount","passingCount","warningCount"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"linked":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller can view, counted for the caller only. The sum of linked, notFound and noAccess equals the number of inputs."},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only."},"notFound":{"type":"integer","format":"int32"}},"required":["linked","noAccess","notFound"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"type":"string","enum":["user","userGroup"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProducts":{"post":{"description":"This endpoint allows you to create a data product from its YAML definition.\n\nThe body has one field, `contents`, which holds the data product YAML. The YAML can have at most 3145728 characters. Example:\n\n```yaml\nkind: data-product\nkey: monthly_revenue_report\nname: Monthly Revenue Report\ndescription: >\n  Month-end revenue in USD by region and segment, built from closed-won\n  opportunities. Feeds the board pack and the revenue dashboard.\nurl: https://looker.company.com/dashboards/monthly-revenue\nowner:\n  type: soda_user_group\n  id: 7c4b91e2-6d38-4a05-9f12-83b0e6d7a249\nattributes:\n  department: Finance\n  business_function: Revenue reporting\n  documentation_url: https://docs.company.com/data-products/monthly-revenue\n  tags:\n    - board-reporting\n    - business-critical\ninputs:\n  - type: dataset\n    dataset: pg/sales_data/crm/opportunities\n  - type: dataset\n    dataset: pg/sales_data/crm/accounts\n  - type: dataset\n    dataset: pg/sales_data/reference/fx_rates\n```\n\nThe `key` of the YAML becomes the `name` of the data product. If another data product already uses this name, the request is rejected with a 400 error and the code `data_product_name_already_exists`. The message gives the `id` of that data product, so that you can publish a new version of it with `POST /api/v1/dataProducts/{dataProductId}`. If you have no permission to view that other data product, the request is rejected with a 403 error and the code `access_denied` instead, and the message does not include its id.\n\nIf the YAML does not parse or does not match the schema, the request is rejected with a 400 error and the code `invalid_request`. If it breaks a data product rule (key, owner, domain, attributes, inputs, outputs), the code is `invalid_data_product`. The message lists each problem on its own line.\n\nThe `domain` of the YAML must be the `name` of a domain in the organization. If domains are not enabled for the organization, a new or changed `domain` is rejected.\n\nA dataset cannot be both an input and an output of the same data product. To add a dataset input or output, you must have permission to view the dataset. An input or output whose dataset is not found is kept, and a warning tells you so.\n\nProblems that do not stop the publish are returned in `warnings`, one sentence each.\n\n## Authorization\n\nOnly users with **Create data products** permission can create data products. Without it, the request is rejected with a 403 error. Soda Cloud Admins have every data product permission on every data product.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/dataProducts","requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDataProductRequestDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateDataProductResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Create a data product","tags":["Data Products"]}}}}
````

## Get a data product

> This endpoint allows you to retrieve a specific data product, including its YAML contents and its health.\
> \
> \`dataProductId\` is the \`id\` of the data product. The \`key\` of its YAML is returned as \`name\`, and the YAML \`name\` as \`label\`.\
> \
> The YAML file is in \`contents\`, and the health of the data product is in \`health\`.\
> \
> Inputs are not part of the data product. Use \`/api/v1/dataProducts/{dataProductId}/inputs\`, which is paged.\
> \
> An unknown id returns 404 with the code \`data\_product\_not\_found\`. To find the id of a data product from its name, use \`GET /api/v1/dataProducts?name=\<name>\`.\
> \
> \## Authorization\
> \
> Only users with \*\*View data product\*\* permission on the data product can view it. Soda Cloud Admins have every data product permission on every data product.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 1000 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiGetDataProductResponse":{"type":"object","properties":{"dataProduct":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"}},"required":["dataProduct"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"domain":{"type":"object","$ref":"#/components/schemas/DataProductDomainContentDTO"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The name of the data product, from the `key` of its YAML. It is unique in the organization and cannot change."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductDomainContentDTO":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","label","name"]},"DataProductHealthContentDTO":{"type":"object","properties":{"checkTotals":{"type":"object","$ref":"#/components/schemas/DataProductCheckTotalsContentDTO","description":"Sums every input of the data product, including the inputs whose dataset the caller cannot view."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"}},"required":["checkTotals","inputs"]},"DataProductCheckTotalsContentDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"inputsWithoutEvidence":{"type":"integer","format":"int32","description":"Inputs on an existing dataset without any check, including the inputs whose dataset the caller cannot view. An input whose checks are all not evaluated is not counted here."},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["failingCount","inputsWithoutEvidence","notEvaluatedCount","passingCount","warningCount"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"linked":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller can view, counted for the caller only. The sum of linked, notFound and noAccess equals the number of inputs."},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only."},"notFound":{"type":"integer","format":"int32"}},"required":["linked","noAccess","notFound"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"type":"string","enum":["user","userGroup"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProducts/{dataProductId}":{"get":{"description":"This endpoint allows you to retrieve a specific data product, including its YAML contents and its health.\n\n`dataProductId` is the `id` of the data product. The `key` of its YAML is returned as `name`, and the YAML `name` as `label`.\n\nThe YAML file is in `contents`, and the health of the data product is in `health`.\n\nInputs are not part of the data product. Use `/api/v1/dataProducts/{dataProductId}/inputs`, which is paged.\n\nAn unknown id returns 404 with the code `data_product_not_found`. To find the id of a data product from its name, use `GET /api/v1/dataProducts?name=<name>`.\n\n## Authorization\n\nOnly users with **View data product** permission on the data product can view it. Soda Cloud Admins have every data product permission on every data product.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n1000 requests/60 seconds","operationId":"GET/api/v1/dataProducts/{dataProductId}","parameters":[{"in":"path","name":"dataProductId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiGetDataProductResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get a data product","tags":["Data Products"]}}}}
```

## Publish a data product

> This endpoint allows you to publish a new YAML definition for an existing data product. The new definition replaces the stored one.\
> \
> The body is the same as for the create endpoint: one field, \`contents\`, which holds the complete data product YAML.\
> \
> \`dataProductId\` is the \`id\` of the data product. To find the id from the name, use \`GET /api/v1/dataProducts?name=\<name>\`.\
> \
> The \`key\` of the YAML must be equal to the \`name\` of the data product \`dataProductId\`. The name of a data product cannot change. If the two are different, the request is rejected with a 400 error and the code \`data\_product\_name\_immutable\`.\
> \
> If the YAML does not parse or does not match the schema, the request is rejected with a 400 error and the code \`invalid\_request\`. If it breaks a data product rule (key, owner, domain, attributes, inputs, outputs), the code is \`invalid\_data\_product\`. The message lists each problem on its own line.\
> \
> The \`domain\` of the YAML must be the \`name\` of a domain in the organization. If domains are not enabled for the organization, a new or changed \`domain\` is rejected.\
> \
> A dataset cannot be both an input and an output of the same data product. To add a dataset input or output, you must have permission to view the dataset. An input or output whose dataset is not found is kept, and a warning tells you so.\
> \
> Problems that do not stop the publish are returned in \`warnings\`, one sentence each.\
> \
> If the YAML is the same as the stored one, nothing is saved. The YAML is still checked against the current state of the organization. If it finds problems, for example a dataset that does not exist or an attribute that was deleted, the request still succeeds. \`warnings\` then starts with "The file is unchanged; nothing was published. Current problems:", followed by one sentence for each problem. If it finds no problems, \`warnings\` is empty.\
> \
> An unknown id returns 404 with the code \`data\_product\_not\_found\`.\
> \
> \## Authorization\
> \
> Only users with \*\*Configure data product\*\* permission on the data product can publish it. Soda Cloud Admins have every data product permission on every data product.\
> \
> A user without \*\*Configure data product\*\* permission gets a 403 error before the YAML is checked.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 100 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDataProductRequestDTO":{"type":"object","properties":{"contents":{"type":"string"}},"required":["contents"]},"PublicApiPublishDataProductResponse":{"type":"object","properties":{"dataProduct":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"},"warnings":{"type":"array","items":{"type":"string"}}},"required":["dataProduct","warnings"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"domain":{"type":"object","$ref":"#/components/schemas/DataProductDomainContentDTO"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The name of the data product, from the `key` of its YAML. It is unique in the organization and cannot change."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductDomainContentDTO":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","label","name"]},"DataProductHealthContentDTO":{"type":"object","properties":{"checkTotals":{"type":"object","$ref":"#/components/schemas/DataProductCheckTotalsContentDTO","description":"Sums every input of the data product, including the inputs whose dataset the caller cannot view."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"}},"required":["checkTotals","inputs"]},"DataProductCheckTotalsContentDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"inputsWithoutEvidence":{"type":"integer","format":"int32","description":"Inputs on an existing dataset without any check, including the inputs whose dataset the caller cannot view. An input whose checks are all not evaluated is not counted here."},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["failingCount","inputsWithoutEvidence","notEvaluatedCount","passingCount","warningCount"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"linked":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller can view, counted for the caller only. The sum of linked, notFound and noAccess equals the number of inputs."},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only."},"notFound":{"type":"integer","format":"int32"}},"required":["linked","noAccess","notFound"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"type":"string","enum":["user","userGroup"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProducts/{dataProductId}":{"post":{"description":"This endpoint allows you to publish a new YAML definition for an existing data product. The new definition replaces the stored one.\n\nThe body is the same as for the create endpoint: one field, `contents`, which holds the complete data product YAML.\n\n`dataProductId` is the `id` of the data product. To find the id from the name, use `GET /api/v1/dataProducts?name=<name>`.\n\nThe `key` of the YAML must be equal to the `name` of the data product `dataProductId`. The name of a data product cannot change. If the two are different, the request is rejected with a 400 error and the code `data_product_name_immutable`.\n\nIf the YAML does not parse or does not match the schema, the request is rejected with a 400 error and the code `invalid_request`. If it breaks a data product rule (key, owner, domain, attributes, inputs, outputs), the code is `invalid_data_product`. The message lists each problem on its own line.\n\nThe `domain` of the YAML must be the `name` of a domain in the organization. If domains are not enabled for the organization, a new or changed `domain` is rejected.\n\nA dataset cannot be both an input and an output of the same data product. To add a dataset input or output, you must have permission to view the dataset. An input or output whose dataset is not found is kept, and a warning tells you so.\n\nProblems that do not stop the publish are returned in `warnings`, one sentence each.\n\nIf the YAML is the same as the stored one, nothing is saved. The YAML is still checked against the current state of the organization. If it finds problems, for example a dataset that does not exist or an attribute that was deleted, the request still succeeds. `warnings` then starts with \"The file is unchanged; nothing was published. Current problems:\", followed by one sentence for each problem. If it finds no problems, `warnings` is empty.\n\nAn unknown id returns 404 with the code `data_product_not_found`.\n\n## Authorization\n\nOnly users with **Configure data product** permission on the data product can publish it. Soda Cloud Admins have every data product permission on every data product.\n\nA user without **Configure data product** permission gets a 403 error before the YAML is checked.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/dataProducts/{dataProductId}","parameters":[{"in":"path","name":"dataProductId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDataProductRequestDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiPublishDataProductResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Publish a data product","tags":["Data Products"]}}}}
```

## Delete a data product

> This endpoint deletes a data product. The deletion is complete when the response is returned.\
> \
> The input datasets and the other data products stay as they are.\
> \
> An unknown id returns 404 with the code \`data\_product\_not\_found\`.\
> \
> \## Authorization\
> \
> Only users with \*\*Delete data product\*\* permission on the data product can delete it. Soda Cloud Admins have every data product permission on every data product.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Auditable\
> \
> This API is marked as \*\*audited\*\* on execution.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 100 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDeleteDataProductResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProducts/{dataProductId}":{"delete":{"description":"This endpoint deletes a data product. The deletion is complete when the response is returned.\n\nThe input datasets and the other data products stay as they are.\n\nAn unknown id returns 404 with the code `data_product_not_found`.\n\n## Authorization\n\nOnly users with **Delete data product** permission on the data product can delete it. Soda Cloud Admins have every data product permission on every data product.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Auditable\n\nThis API is marked as **audited** on execution.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"DELETE/api/v1/dataProducts/{dataProductId}","parameters":[{"in":"path","name":"dataProductId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDeleteDataProductResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Delete a data product","tags":["Data Products"]}}}}
```

## List data product inputs

> This endpoint allows you to list the inputs of a data product, with the check results of each input.\
> \
> This GET is a paginated API that uses the following parameters to request specific details:\
> \
> \- \`cursor\`: Omit for the first page. Pass the previous response's \`nextCursor\`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\
> \
> \- \`size\`: Number of items per page, from 1 to 1000, default 10. The size may change between pages.\
> \
> The response contains \`content\` and, when more items are available, \`nextCursor\`. An absent \`nextCursor\` marks the end of the results. Page numbers and totals are not returned.\
> \
> Inputs whose dataset you cannot view are left out of this list and counted in the product's \`health.inputs.noAccess\`; their qualified names still appear in the product's \`contents\`.\
> \
> An unknown id returns 404 with the code \`data\_product\_not\_found\`. To find the id of a data product from its name, use \`GET /api/v1/dataProducts?name=\<name>\`.\
> \
> \## Authorization\
> \
> Only users with \*\*View data product\*\* permission on the data product can list its inputs. Soda Cloud Admins have every data product permission on every data product.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 60 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiListDataProductInputsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataProductInputContentDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"DataProductInputContentDTO":{"type":"object","properties":{"dataset":{"type":"object","$ref":"#/components/schemas/DataProductDatasetInputContentDTO"},"id":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/DataProductInputTypeContentDTO"}},"required":["dataset","id","type"]},"DataProductDatasetInputContentDTO":{"type":"object","properties":{"checkResults":{"type":"object","$ref":"#/components/schemas/DataProductCheckResultsContentDTO"},"datasetId":{"type":"string"},"lastEvaluated":{"type":"string","format":"date-time"},"qualifiedName":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductInputStateContentDTO","description":"`linked`: the qualified name matches a Soda Core v4 dataset in this organization, and `datasetId` is set. `notFound`: no such dataset exists yet. The input becomes `linked` when the dataset appears."}},"required":["qualifiedName","state"]},"DataProductCheckResultsContentDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["failingCount","notEvaluatedCount","passingCount","warningCount"]},"DataProductInputStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductInputTypeContentDTO":{"type":"string","enum":["dataset"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProducts/{dataProductId}/inputs":{"get":{"description":"This endpoint allows you to list the inputs of a data product, with the check results of each input.\n\nThis GET is a paginated API that uses the following parameters to request specific details:\n\n- `cursor`: Omit for the first page. Pass the previous response's `nextCursor`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\n\n- `size`: Number of items per page, from 1 to 1000, default 10. The size may change between pages.\n\nThe response contains `content` and, when more items are available, `nextCursor`. An absent `nextCursor` marks the end of the results. Page numbers and totals are not returned.\n\nInputs whose dataset you cannot view are left out of this list and counted in the product's `health.inputs.noAccess`; their qualified names still appear in the product's `contents`.\n\nAn unknown id returns 404 with the code `data_product_not_found`. To find the id of a data product from its name, use `GET /api/v1/dataProducts?name=<name>`.\n\n## Authorization\n\nOnly users with **View data product** permission on the data product can list its inputs. Soda Cloud Admins have every data product permission on every data product.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"GET/api/v1/dataProducts/{dataProductId}/inputs","parameters":[{"in":"path","name":"dataProductId","required":true,"schema":{"type":"string"}},{"in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"size","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiListDataProductInputsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List data product inputs","tags":["Data Products"]}}}}
```

## List data product outputs

> This endpoint allows you to list the outputs of a data product: the datasets and the dashboards that it provides.\
> \
> This GET is a paginated API that uses the following parameters to request specific details:\
> \
> \- \`cursor\`: Omit for the first page. Pass the previous response's \`nextCursor\`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\
> \
> \- \`size\`: Number of items per page, from 1 to 1000, default 10. The size may change between pages.\
> \
> The response contains \`content\` and, when more items are available, \`nextCursor\`. An absent \`nextCursor\` marks the end of the results. Page numbers and totals are not returned.\
> \
> Every output of the data product is listed, also a dataset output whose dataset you cannot view. Such an output comes in \`noAccessDataset\`, not in \`dataset\`, with only the dataset id, the qualified name and \`accessCapability\`: \`pending\` when you already asked for access to it through this data product, \`canRequest\` when you have not. A dataset output that you can view has \`accessCapability\` \`canView\`.\
> \
> For a \`canRequest\` output, a person can ask for access with \`POST /api/v1/dataProductAccessRequests\`. A service account gets \`canRequest\` too, but cannot ask for access: that request returns 403 with the code \`invalid\_user\_type\`.\
> \
> An unknown id returns 404 with the code \`data\_product\_not\_found\`. To find the id of a data product from its name, use \`GET /api/v1/dataProducts?name=\<name>\`.\
> \
> \## Authorization\
> \
> Only users with \*\*View data product\*\* permission on the data product can list its outputs. Soda Cloud Admins have every data product permission on every data product.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Tags\
> \
> \`Data Products\`\
> \
> \## Rate limiting\
> \
> 60 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Data Product Endpoints","name":"Data Products"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiListDataProductOutputsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataProductOutputContentDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"DataProductOutputContentDTO":{"type":"object","properties":{"dashboard":{"type":"object","$ref":"#/components/schemas/DataProductDashboardOutputContentDTO","description":"Set only when `type` is `dashboard`."},"dataset":{"type":"object","$ref":"#/components/schemas/DataProductDatasetOutputContentDTO","description":"Set only when `type` is `dataset` and you can view the dataset, or no such dataset exists yet."},"id":{"type":"string"},"noAccessDataset":{"type":"object","$ref":"#/components/schemas/DataProductNoAccessDatasetOutputContentDTO","description":"Set only when `type` is `dataset` and you cannot view the dataset. It holds only the id and the qualified name of the dataset, and whether you can ask for access to it."},"type":{"type":"object","$ref":"#/components/schemas/DataProductOutputTypeContentDTO"}},"required":["id","type"]},"DataProductDashboardOutputContentDTO":{"type":"object","properties":{"url":{"type":"string","description":"Absent when the dashboard output has no URL."}}},"DataProductDatasetOutputContentDTO":{"type":"object","properties":{"accessCapability":{"type":"object","$ref":"#/components/schemas/DataProductOutputAccessCapabilityContentDTO","description":"`canView` when `state` is `linked`, absent when it is `notFound`."},"datasetId":{"type":"string"},"qualifiedName":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOutputStateContentDTO","description":"`linked`: the qualified name matches a Soda Core v4 dataset in this organization, and `datasetId` is set. `notFound`: no such dataset exists yet. The output becomes `linked` when the dataset appears."}},"required":["qualifiedName","state"]},"DataProductOutputAccessCapabilityContentDTO":{"type":"string","enum":["canView","pending","canRequest"]},"DataProductOutputStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductNoAccessDatasetOutputContentDTO":{"type":"object","properties":{"accessCapability":{"type":"object","$ref":"#/components/schemas/DataProductOutputAccessCapabilityContentDTO","description":"`pending`: you asked for access to this dataset through this data product, and the request waits for a decision. `canRequest`: you have no pending request for it. A person can ask for access with `POST /api/v1/dataProductAccessRequests`; a service account cannot."},"datasetId":{"type":"string"},"qualifiedName":{"type":"string"}},"required":["accessCapability","datasetId","qualifiedName"]},"DataProductOutputTypeContentDTO":{"type":"string","enum":["dataset","dashboard"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/dataProducts/{dataProductId}/outputs":{"get":{"description":"This endpoint allows you to list the outputs of a data product: the datasets and the dashboards that it provides.\n\nThis GET is a paginated API that uses the following parameters to request specific details:\n\n- `cursor`: Omit for the first page. Pass the previous response's `nextCursor`, with the same other parameters, to continue after its last item. Cursors are opaque; invalid cursors return 400.\n\n- `size`: Number of items per page, from 1 to 1000, default 10. The size may change between pages.\n\nThe response contains `content` and, when more items are available, `nextCursor`. An absent `nextCursor` marks the end of the results. Page numbers and totals are not returned.\n\nEvery output of the data product is listed, also a dataset output whose dataset you cannot view. Such an output comes in `noAccessDataset`, not in `dataset`, with only the dataset id, the qualified name and `accessCapability`: `pending` when you already asked for access to it through this data product, `canRequest` when you have not. A dataset output that you can view has `accessCapability` `canView`.\n\nFor a `canRequest` output, a person can ask for access with `POST /api/v1/dataProductAccessRequests`. A service account gets `canRequest` too, but cannot ask for access: that request returns 403 with the code `invalid_user_type`.\n\nAn unknown id returns 404 with the code `data_product_not_found`. To find the id of a data product from its name, use `GET /api/v1/dataProducts?name=<name>`.\n\n## Authorization\n\nOnly users with **View data product** permission on the data product can list its outputs. Soda Cloud Admins have every data product permission on every data product.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Data Products`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"GET/api/v1/dataProducts/{dataProductId}/outputs","parameters":[{"in":"path","name":"dataProductId","required":true,"schema":{"type":"string"}},{"in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"size","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiListDataProductOutputsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List data product outputs","tags":["Data Products"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.soda.io/apis/rest-api/data-products.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
