Skip to main content
GET
/
reports
/
{reportId}
/
embed
Get Embed URL
curl --request GET \
  --url https://api.mapademics.com/v1/reports/{reportId}/embed \
  --header 'X-API-Key: <api-key>'
{
  "embedUrl": "https://app.mapademics.com/embed/reports/clx123456?token=abc123",
  "reportId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "width": "100%",
  "height": "600px"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Path Parameters

​
reportId
string
required

Unique identifier for the report

Response

Embed URL retrieved successfully

​
embedUrl
string<uri>
required

Full URL for embedding in iframe

Example:

"https://app.mapademics.com/embed/reports/clx123456?token=abc123"

​
reportId
string
required
​
expiresAt
string<date-time> | null
required

When the embed token expires

​
width
string

Recommended iframe width

Example:

"100%"

​
height
string

Recommended iframe height

Example:

"600px"