Builder accessEmbed page

Embed page

Returns a small HTML page that loads the builder in a sandboxed iframe. Point an <iframe> or a browser tab at this URL. A page load cannot set headers, so this is the one builder route that takes the key in the query string (ak or sk) instead of the Authorization header. Use a viewer key (sk_) for client-facing embeds, because the URL is visible to anyone who can see the page. The key format is checked here; the key itself is checked by the embedded app through GET /validate.

curl -X GET "https://mythic-analytics.gulp.workers.dev/builder/?ak=example_string&sk=example_string&location_id=example_string&page=dashboards&theme=dark&transparent=example_string&hideHeader=example_string&branding=example_string&theme_primary=example_string&theme_secondary=example_string&theme_heading_font=example_string&theme_body_font=example_string&style=example_string" \
  -H "Content-Type: application/json"
{}
GET
/
GET
Base URLstring

Target server for requests. Edit to use your own host.

query
akstring

Agency key (ak_ followed by 32 to 64 hex characters). Pass ak or sk.

query
skstring

Viewer key (sk_ followed by 32 to 64 hex characters). With ak, scopes the embed to that key's client.

query
location_idstring

Client to open when the key is an agency key.

query
pagestring

Builder page to open. Lowercase letters only; anything else opens insights.

query
themestring

Color theme passed to the embedded app.

query
transparentstring

Render without a page background.

query
hideHeaderstring

Hide the builder header.

query
brandingstring

Branding mode passed to the embedded app.

query
theme_primarystring

Primary color override.

query
theme_secondarystring

Secondary color override.

query
theme_heading_fontstring

Heading font override.

query
theme_body_fontstring

Body font override.

query
stylestring

Style preset passed to the embedded app.

Request Preview
Response

Response will appear here after sending the request

Query Parameters

akstring

Agency key (ak_ followed by 32 to 64 hex characters). Pass ak or sk.

skstring

Viewer key (sk_ followed by 32 to 64 hex characters). With ak, scopes the embed to that key's client.

location_idstring

Client to open when the key is an agency key.

pagestring

Builder page to open. Lowercase letters only; anything else opens insights.

Example:
dashboards
themestring

Color theme passed to the embedded app.

Example:
dark
transparentstring

Render without a page background.

hideHeaderstring

Hide the builder header.

brandingstring

Branding mode passed to the embedded app.

theme_primarystring

Primary color override.

theme_secondarystring

Secondary color override.

theme_heading_fontstring

Heading font override.

theme_body_fontstring

Body font override.

stylestring

Style preset passed to the embedded app.

Responses

HTML wrapper page. Sent with Cache-Control no-store and a strict Content-Security-Policy.