Skip to content

SUPP-97: Clarify Raw Event Export event input with JSON array example#6

Draft
myronkaifung with Copilot wants to merge 2 commits into
mainfrom
copilot/supp-97-show-json-array-example
Draft

SUPP-97: Clarify Raw Event Export event input with JSON array example#6
myronkaifung with Copilot wants to merge 2 commits into
mainfrom
copilot/supp-97-show-json-array-example

Conversation

Copilot AI commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

The Raw Event Export reference page described event as a JSON array but did not show the exact input shape users should paste into the playground field. This update adds an explicit example at the OpenAPI parameter level so the format is immediately clear.

  • API reference input clarity

    • Updated openapi/export.openapi.yaml for GET /export → query param event.
    • Added a concrete schema example and in-line description example using a valid JSON array of event names.
  • Rendered docs impact

    • Improves the Mintlify reference/playground UX by showing users the expected input format directly where they enter it.
- in: query
  name: event
  schema:
    type: string
    example: '["signup","purchase"]'
  description: The event or events that you wish to get data for, encoded as a JSON array (for example, `["signup","purchase"]`).
Original prompt
<title>Show an example of what a JSON array of events looks like</title> Suggestion from the Mintlify docs QA tracker.

Show an example of what a JSON array of events looks like — the input users have to paste into the text box on the raw event export reference page.

Affected page: https://mixpanel-edb78807.mintlify.app/reference/raw-event-export?playground=open

_Reported 2026-06-03. Source entry (with screenshot): https://app.notion.com/p/368e0ba925628059b17cc76fa02805fa_



Only assign incident/ labels when asked to by a user. incident/ labels are reserved for customer facing incidents.
Fixes https://linear.app/mixpanel/issue/SUPP-97/show-an-example-of-what-a-json-array-of-events-looks-like

Branch naming

This task relates to issue SUPP-97 — preserve that identifier somewhere in the branch name and pull request title for traceability. Do not treat the identifier as a verbatim slug or prepend it with a hyphen by default; instead, adapt the full branch name to comply with the repository's branch-naming pattern, adding any required prefix or restructuring the shape as needed.

Include a link to the original issue in the pull request description: https://linear.app/mixpanel/issue/SUPP-97/show-an-example-of-what-a-json-array-of-events-looks-like

@linear-code

linear-code Bot commented Jun 4, 2026

Copy link
Copy Markdown
SUPP-97 Show an example of what a JSON array of events looks like

Suggestion from the Mintlify docs QA tracker.

Show an example of what a JSON array of events looks like — the input users have to paste into the text box on the raw event export reference page.

Affected page: https://mixpanel-edb78807.mintlify.app/reference/raw-event-export?playground=open

_Reported 2026-06-03. Source entry (with screenshot): https://app.notion.com/p/368e0ba925628059b17cc76fa02805fa_

Review in Linear · Agent session

Copilot AI changed the title [WIP] Show an example of JSON array of events SUPP-97: Clarify Raw Event Export event input with JSON array example Jun 4, 2026
Copilot AI requested a review from myronkaifung June 4, 2026 05:00
@gitar-bot

gitar-bot Bot commented Jun 4, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Adds a concrete JSON array example to the Raw Event Export event query parameter in the OpenAPI spec, improving clarity for users in the documentation playground. No issues found.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@greptile-apps greptile-apps Bot mentioned this pull request Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants