This API is available as an add-on to your June Subscription
You can embed June charts and insights into your product with our Embed API. Each request needs to be authenticated using a secret API key. To generate a key for your workspace click here.
Here's a list of endpoints to manage your June Embeds.
Dashboards
List Tokens - GET /api/platform/dashboards/tokens
Example cURL request to this endpoint:
curl -X GET "https://api.june.so/api/platform/dashboards/tokens" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json"
Get Token - GET /api/platform/dashboards/token/:id
Parameters | Type | Example value |
id | Integer | 104 |
Example cURL request to this endpoint:
curl -X GET "https://api.june.so/api/platform/dashboards/tokens/YOUR_TOKEN_ID" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json"
Create Token - POST /api/platform/dashboards/tokens
Parameters | Type | Example value |
dashboard_id | Integer - Optional | 11 |
group_id | String - Optional | b0313843-361f-4287-b979-67fd3cd114c2 |
expiry_date | Date - Optional | 2024-01-01T00:00:00.000Z |
When specifying a group_id
for your tokens you will restrict access for the token to only be able to view charts for a specific group_id
. This is useful when you're embedding dashboards as part of your product and you don't want your users to be able to see data for other customers.
Example cURL request to this endpoint:
curl -X POST "https://api.june.so/api/platform/dashboards/tokens" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"dashboard_id": 114, group_id: "b0313843-361f-4287-b979-67fd3cd114c2", "expiry_date":"2024-01-01T00:00:00.000Z"}'
Delete Token - GET /api/platform/dashboards/token/:id
Parameters | Type | Example value |
id | Integer | 104 |
Example cURL request to this endpoint:
curl -X DELETE "https://api.june.so/api/platform/reports/tokens/YOUR_TOKEN_ID" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json"
Reports
List Tokens - GET /api/platform/reports/tokens
Example cURL request to this endpoint:
curl -X GET "https://api.june.so/api/platform/reports/tokens" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json"
Get Token - GET /api/platform/reports/token/:id
Parameters | Type | Example value |
id | Integer | 104 |
Example cURL request to this endpoint:
curl -X GET "https://api.june.so/api/platform/reports/tokens/YOUR_TOKEN_ID" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json"
Create Token - POST /api/platform/reports/tokens
Parameters | Type | Example value |
report_id | Integer - Required | 114 |
insight_id | Integer - Optional | 11 |
group_id | String - Optional | b0313843-361f-4287-b979-67fd3cd114c2 |
expiry_date | Date - Optional | 2024-01-01T00:00:00.000Z |
When specifying a group_id
for your tokens you will restrict access for the token to only be able to view charts for a specific group_id
. This is useful when you're embedding reports as part of your product and you don't want your users to be able to see data for other customers.
Example cURL request to this endpoint:
curl -X POST "https://api.june.so/api/platform/reports/tokens" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"report_id": 114, "insight_id": 11, group_id: "b0313843-361f-4287-b979-67fd3cd114c2", "expiry_date":"2024-01-01T00:00:00.000Z"}'
Delete Token - GET /api/platform/reports/token/:id
Parameters | Type | Example value |
id | Integer | 104 |
Example cURL request to this endpoint:
curl -X DELETE "https://api.june.so/api/platform/reports/tokens/YOUR_TOKEN_ID" \
-H "Authorization: Basic YOUR_SECRET_API_KEY" \
-H "Content-Type: application/json"