|
| 1 | +--- |
| 2 | +title: LogRocket |
| 3 | +description: Summarize sessions, manage users, and tag releases in LogRocket |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="logrocket" |
| 10 | + color="#764ABC" |
| 11 | +/> |
| 12 | + |
| 13 | +{/* MANUAL-CONTENT-START:intro */} |
| 14 | +[LogRocket](https://logrocket.com/) is a session replay and product analytics platform for frontend applications. It records what users actually did — clicks, navigation, network requests, console output, and application state — so teams can see the exact path that led to a bug, a drop-off, or a support ticket instead of asking the customer to reproduce it. |
| 15 | + |
| 16 | +With LogRocket, you can: |
| 17 | + |
| 18 | +- **Summarize sessions with AI**: Galileo Highlights reads a user's sessions and answers a plain-English question about them, returning a markdown summary plus per-session breakdowns. |
| 19 | +- **Identify users**: Attach names, emails, and custom traits to a user so sessions can be segmented by plan, lifecycle stage, or account value. |
| 20 | +- **Export session data**: Pull download URLs for JSON Lines session exports and load them into a warehouse. |
| 21 | +- **Audit session access**: Page through the audit log to see who viewed which sessions and when. |
| 22 | +- **Tag releases**: Register a deployed version so uploaded source maps decode its stack traces. |
| 23 | + |
| 24 | +Sim's LogRocket integration lets your agents run these operations programmatically. Use it to enrich a support ticket with a session summary, turn a vague bug report into reproduction steps, keep user traits in sync with your CRM, or register a release as part of a deploy workflow. |
| 25 | + |
| 26 | +Highlights requests are asynchronous: **Request Highlights** returns an ID and **Get Highlights** reports `PENDING` until generation finishes (typically one to three minutes), then `READY` or `FAILED`. Poll it rather than expecting the summary immediately. |
| 27 | + |
| 28 | +LogRocket has no REST API for querying sessions, issues, or metrics directly — that data is available through their [MCP server](https://docs.logrocket.com/docs/mcp) at `https://mcp.logrocket.com/mcp`, which you can add to Sim as an MCP server connection alongside this block. |
| 29 | +{/* MANUAL-CONTENT-END */} |
| 30 | + |
| 31 | + |
| 32 | +## Usage Instructions |
| 33 | + |
| 34 | +Integrate LogRocket into your workflow to request AI session highlights for a user, poll for the result, list exported session files, read the audit log, create or update user profiles, and register releases so source maps decode their stack traces. |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | +## Actions |
| 39 | + |
| 40 | +### LogRocket Request Highlights |
| 41 | + |
| 42 | +Start a Galileo session highlights job for a user. Returns a request ID to poll with LogRocket's Get Highlights operation. |
| 43 | + |
| 44 | +#### Input |
| 45 | + |
| 46 | +| Parameter | Type | Required | Description | |
| 47 | +| --------- | ---- | -------- | ----------- | |
| 48 | +| `apiKey` | string | Yes | LogRocket API key | |
| 49 | +| `orgId` | string | Yes | LogRocket organization ID | |
| 50 | +| `appId` | string | Yes | LogRocket project \(app\) ID | |
| 51 | +| `apiHost` | string | No | API host override for Private Cloud deployments | |
| 52 | +| `userEmail` | string | No | Email of the user to summarize. Required if no user ID is given. | |
| 53 | +| `userID` | string | No | ID of the user to summarize. Required if no email is given. | |
| 54 | +| `question` | string | No | Question to focus the highlights on | |
| 55 | +| `startMs` | string | No | Start of the session window, in milliseconds since epoch | |
| 56 | +| `endMs` | string | No | End of the session window, in milliseconds since epoch | |
| 57 | +| `webhookURL` | string | No | URL notified when the highlights job finishes | |
| 58 | + |
| 59 | +#### Output |
| 60 | + |
| 61 | +| Parameter | Type | Description | |
| 62 | +| --------- | ---- | ----------- | |
| 63 | +| `id` | string | Request ID used to retrieve the highlights result | |
| 64 | + |
| 65 | +### LogRocket Get Highlights |
| 66 | + |
| 67 | +Retrieve the result of a Galileo session highlights request. Status is PENDING until generation finishes, then READY or FAILED. |
| 68 | + |
| 69 | +#### Input |
| 70 | + |
| 71 | +| Parameter | Type | Required | Description | |
| 72 | +| --------- | ---- | -------- | ----------- | |
| 73 | +| `apiKey` | string | Yes | LogRocket API key | |
| 74 | +| `orgId` | string | Yes | LogRocket organization ID | |
| 75 | +| `appId` | string | Yes | LogRocket project \(app\) ID | |
| 76 | +| `apiHost` | string | No | API host override for Private Cloud deployments | |
| 77 | +| `id` | string | Yes | Request ID returned by the Request Highlights operation | |
| 78 | + |
| 79 | +#### Output |
| 80 | + |
| 81 | +| Parameter | Type | Description | |
| 82 | +| --------- | ---- | ----------- | |
| 83 | +| `status` | string | Job status: PENDING, READY, or FAILED | |
| 84 | +| `requestID` | string | ID of the highlights request | |
| 85 | +| `appID` | string | LogRocket project the request belongs to | |
| 86 | +| `highlights` | string | Markdown summary across the matched sessions. Present when status is READY. | |
| 87 | +| `sessions` | array | Per-session highlights | |
| 88 | +| ↳ `recordingID` | string | LogRocket recording ID | |
| 89 | +| ↳ `sessionID` | number | Session number within the recording | |
| 90 | +| ↳ `highlights` | string | Highlights for this session | |
| 91 | + |
| 92 | +### LogRocket List Exported Sessions |
| 93 | + |
| 94 | +List exported session files from the LogRocket Data Export API. Returns download URLs for JSON Lines exports, oldest first, plus a cursor for the next page. |
| 95 | + |
| 96 | +#### Input |
| 97 | + |
| 98 | +| Parameter | Type | Required | Description | |
| 99 | +| --------- | ---- | -------- | ----------- | |
| 100 | +| `apiKey` | string | Yes | LogRocket API key | |
| 101 | +| `orgId` | string | Yes | LogRocket organization ID | |
| 102 | +| `appId` | string | Yes | LogRocket project \(app\) ID | |
| 103 | +| `apiHost` | string | No | API host override for Private Cloud deployments | |
| 104 | +| `cursor` | string | No | Cursor from a previous page, used to fetch newer sessions | |
| 105 | +| `limit` | string | No | Results per page. Defaults to 10, maximum 100. | |
| 106 | +| `date` | string | No | Unix timestamp in milliseconds to start listing from | |
| 107 | + |
| 108 | +#### Output |
| 109 | + |
| 110 | +| Parameter | Type | Description | |
| 111 | +| --------- | ---- | ----------- | |
| 112 | +| `sessions` | array | Exported session files | |
| 113 | +| ↳ `url` | string | Download URL for the JSON Lines export file | |
| 114 | +| `cursor` | string | Opaque cursor for the next page of results | |
| 115 | + |
| 116 | +### LogRocket Get Audit Logs |
| 117 | + |
| 118 | +Export audit log entries from LogRocket, recording who viewed sessions and what actions were taken. Paginated with a cursor. |
| 119 | + |
| 120 | +#### Input |
| 121 | + |
| 122 | +| Parameter | Type | Required | Description | |
| 123 | +| --------- | ---- | -------- | ----------- | |
| 124 | +| `apiKey` | string | Yes | LogRocket API key | |
| 125 | +| `orgId` | string | Yes | LogRocket organization ID | |
| 126 | +| `appId` | string | Yes | LogRocket project \(app\) ID | |
| 127 | +| `apiHost` | string | No | API host override for Private Cloud deployments | |
| 128 | +| `limit` | string | No | Number of audit log records to return | |
| 129 | +| `cursor` | string | No | Cursor from a previous page, used to fetch the next page | |
| 130 | + |
| 131 | +#### Output |
| 132 | + |
| 133 | +| Parameter | Type | Description | |
| 134 | +| --------- | ---- | ----------- | |
| 135 | +| `logs` | array | Audit log entries | |
| 136 | +| ↳ `time` | string | Formatted timestamp of the action | |
| 137 | +| ↳ `createdDate` | string | ISO 8601 timestamp of the action | |
| 138 | +| ↳ `user` | string | Email or system ID of the actor | |
| 139 | +| ↳ `action` | string | Action taken, e.g. Viewed session | |
| 140 | +| ↳ `description` | string | Action details, e.g. the session ID | |
| 141 | +| `cursor` | string | Opaque cursor for the next page of results | |
| 142 | +| `hasNext` | boolean | Whether more audit logs exist beyond this page | |
| 143 | + |
| 144 | +### LogRocket Identify User |
| 145 | + |
| 146 | +Create or update a LogRocket user profile with demographic, financial, and engagement traits. |
| 147 | + |
| 148 | +#### Input |
| 149 | + |
| 150 | +| Parameter | Type | Required | Description | |
| 151 | +| --------- | ---- | -------- | ----------- | |
| 152 | +| `apiKey` | string | Yes | LogRocket API key | |
| 153 | +| `orgId` | string | Yes | LogRocket organization ID | |
| 154 | +| `appId` | string | Yes | LogRocket project \(app\) ID | |
| 155 | +| `apiHost` | string | No | API host override for Private Cloud deployments | |
| 156 | +| `userId` | string | Yes | ID of the user to create or update | |
| 157 | +| `name` | string | No | Display name of the user. Maximum 1024 characters. | |
| 158 | +| `email` | string | No | Email of the user. Maximum 1024 characters. | |
| 159 | +| `timestamp` | string | No | Unix timestamp in milliseconds describing when the submitted data was true | |
| 160 | +| `traits` | string | No | JSON object of custom traits. Each key and value is limited to 1024 characters and stored as a string. | |
| 161 | + |
| 162 | +#### Output |
| 163 | + |
| 164 | +| Parameter | Type | Description | |
| 165 | +| --------- | ---- | ----------- | |
| 166 | +| `userID` | string | ID of the created or updated user | |
| 167 | +| `name` | string | Display name stored on the profile | |
| 168 | +| `email` | string | Email stored on the profile | |
| 169 | +| `traits` | json | Custom traits stored on the profile, with every value coerced to a string | |
| 170 | + |
| 171 | +### LogRocket Create Release |
| 172 | + |
| 173 | +Register a release version in LogRocket so uploaded source maps can decode stack traces for it. Fails with a conflict if the version already exists. |
| 174 | + |
| 175 | +#### Input |
| 176 | + |
| 177 | +| Parameter | Type | Required | Description | |
| 178 | +| --------- | ---- | -------- | ----------- | |
| 179 | +| `apiKey` | string | Yes | LogRocket API key | |
| 180 | +| `orgId` | string | Yes | LogRocket organization ID | |
| 181 | +| `appId` | string | Yes | LogRocket project \(app\) ID | |
| 182 | +| `apiHost` | string | No | API host override for Private Cloud deployments | |
| 183 | +| `version` | string | Yes | Release version to register, e.g. 1.2.3 or a commit SHA | |
| 184 | + |
| 185 | +#### Output |
| 186 | + |
| 187 | +| Parameter | Type | Description | |
| 188 | +| --------- | ---- | ----------- | |
| 189 | +| `version` | string | Release version that was registered | |
| 190 | + |
| 191 | + |
0 commit comments