Skip to main content
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
pull-requests
/
preview
Error
A valid request URL is required to generate request examples
{
  "results": {
    "previewUrl": "<string>"
  }
}

Path Parameters

ā€‹
projectUuid
string
required

Query Parameters

ā€‹
prUrl
string
required

Response

Success

ā€‹
results
object
required

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).

ā€‹
status
enum<string>
required
Available options:
ok