Error
A valid request URL is required to generate request examples{
"results": {
"previewUrl": "<string>"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Pull Requests
Get pull request preview
Resolve the Lightdash preview environment URL for a write-back pull
request. Returns { previewUrl: null } until the preview is published,
so the client can poll.
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
pull-requests
/
preview
Error
A valid request URL is required to generate request examples{
"results": {
"previewUrl": "<string>"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Path Parameters
Query Parameters
Response
Success
The Lightdash preview environment for a pull request. previewUrl is null
until a preview has been published: the dbt repo's CI creates the preview
project asynchronously and comments its URL on the PR, so the URL can only be
discovered after the fact (it is not predictable from the PR itself).
Show child attributes
Show child attributes
Available options:
ok Was this page helpful?