Get a project's report

GET/projects/{pid}/pdf

projects:read EnterpriseOpen GuestSince v2

The PDF report on its own: Export a project with formats: ["pdf"], its options in the query. The answer is the same: a link that works for 24 hours, not the file itself. Without Products: read the report leaves its prices out.

Request

curl 'https://api.measuremaponline.com/api/v2/projects/Xr7Lp2Qm9KdT4wZs/pdf' \
  -H "Authorization: $MMO_API_KEY"

Response

{
  "type": "export",
  "projectId": "Xr7Lp2Qm9KdT4wZs",
  "files": [
    {
      "name": "14 Harbour Road.pdf",
      "format": "pdf",
      "contentType": "application/pdf",
      "url": "https://storage.googleapis.com/example/app/projects/Xr7Lp2Qm9KdT4wZs/exports/3f9a1c2b7d4e5f60/14%20Harbour%20Road.pdf?X-Goog-Expires=86400&X-Goog-Signature=5c0f2e9a"
    }
  ],
  "expiresOn": 1792087654000
}

Path parameters

pidstringrequired
The project's ID, the part after /p/ in its address in the app.

Query parameters

designstring
The report's design.
One offieldsurveybrief
languagestring
The report's language: en, es, de, fr, pt, ru, ja, hi or id (Indonesian). English when left out or another.
pageSizestring
A4 or US Letter.
One ofA4LETTER
orientationstring
Portrait or landscape pages.
One ofportraitlandscape
pictureSizestring
How large the shapes' pictures are printed.
One ofsmallnormalbig

Responses

Export:
- typestringrequired
  Always"export"
- projectIdstringrequired
- filesarray of ExportFilerequired
- expiresOninteger(int64)required
  When the links stop working, 24 hours after the export. Download the files before then.

Errors

A failed request answers with one of these, in an Error body.

400invalid_bodyA value in the request body is missing, has the wrong type, is too long or is not one of the accepted values.

401unauthorized_actionThe item is not on your account or your members', the request came from a web page on a website the key does not allow, or the action is not allowed for this person.

403insufficient_scopeThe key does not have the access this endpoint needs. Create a key with that access.

403invalid_api_keyNo key was sent in the Authorization header, or the key is unknown, revoked, or past the time it kept working after being replaced.

404project_not_foundThe project does not exist.

429too_many_requestsYour account reached an hourly limit, such as 600 tokens or 120 export builds an hour. Wait a little and try again; see Rate limits.

Try it

API key

This key is

The key stays in this tab and goes only to the API. Use a sandbox key while you try things: requests are real, and what they change is changed.

GET https://api.measuremaponline.com/api/v2/projects/Xr7Lp2Qm9KdT4wZs/pdf

Fill in your API key to send.

As a cURL command

Shell

curl 'https://api.measuremaponline.com/api/v2/projects/Xr7Lp2Qm9KdT4wZs/pdf' \
  -H "Authorization: $MMO_API_KEY"