Get Plugin History
Retrieve a user’s plugin history.
Available to: Traders (own records); organization administrators (any user in their organization)
Environments: Live
Rate Limit: No endpoint-specific limit
Return a user’s plugin history for a given entitlement as a JSON document. Pass the entitlementName. To read another user’s history, an organization administrator also passes that user’s userId; omit userId to read your own. The response returns the history in the jsonHistory field.
Common Failure Scenarios
- The request includes
userIdand the caller isn’t an organization administrator. This returnsHTTP 401even whenuserIdis the caller’s own ID, so omituserIdto read your own history. - No user matches
userId, or you can’t access that user. Both returnHTTP 404with an empty body. Most organization administrators can’t access users outside their organization. - The caller’s user type, or the API key’s permissions, don’t include full access to the
Usersresource. This returnsHTTP 401with"Access is denied". entitlementNameis empty or longer than 64 characters, oruserIdisn’t greater than 0. These returnHTTP 400.- The request is sent to Demo. This endpoint runs on Live only, so Demo returns
HTTP 501. - The user has no plugin history for
entitlementName. The call still succeeds (HTTP 200with noerrorText), andjsonHistoryis the string"[]"(an empty JSON list). - The history lookup fails or times out. This returns
HTTP 200with the reason inerrorText.
This endpoint returns HTTP 200 for both successful and rejected requests, so check the errorText field to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.
Error Messages
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed