Web Presence Review

Get Pdf Summary By Id

This API endpoint returns a PDF summary of a web presence review. This API requires a valid API key (X-API-KEY) to be provided in the headers and is rate limited to 5 requests per second.

PDF summaries are rendered on demand, so this request is what starts generation. If the PDF does not exist yet, or needs to be regenerated, a HTTP 202 is returned and rendering begins; repeat the request until it returns a HTTP 200, whose body is the PDF. Rendering usually takes about a minute.

Rather than polling, you can subscribe to the one_time.web_presence_review.pdf_summary.status webhook event, which is emitted when the render finishes. That event is only emitted for a review whose PDF was requested here.

get/api/v1/pdf_summary/{web_presence_review_id}

Path parameters

web_presence_review_idstring uuid required

Response

OK

string binary required

The pdf data (mime-type: application/pdf).

Changes

Changed in 1 of the 12 revisions of this API.1