Analytics Events Export API

1.0.0

Overview

Statistics
2 Operations
0 Skills
Analytics Category
Export raw analytics events captured by MuleSoft API gateways. Filter by date range, API, and version with up to 20,000 events per request and a one-month retention window.

Servers

  • https://anypoint.mulesoft.com/analytics/{version}/{organizationId}
  • https://{region}.anypoint.mulesoft.com/analytics/{version}/{organizationId}
  • https://{region}.platform.mulesoft.com/analytics/{version}/{organizationId}

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

Get Events getEvents

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Queries for API events that can be exported in either JSON or CSV format

Query Parameters

apiIds: string
Comma-delimited list of API IDs that will be included as part of the query. Omit or specify 'all' or '*' to include all APIs.
apiVersionIds: string
fields: string
format *: string
Either csv or json. This determines the format in which the events will be exported from the API.
maxResults: integer
Maximum number of events to be included in the response. Default and maximum allowed value is 20000.
startDate: string(date-time)
Date and time, as defined by the ISO 8601 standard
endDate: string(date-time)
Date and time, as defined by the ISO 8601 standard
duration: string
pathPrefix: string
Filter results by event resource path, used when reporting against a particular REST resource root

Response

Successful operation.
Examples
*/*
[ { "Status Code": 200, "Verb": "GET", "Hardware Platform": "Other", "Application": "45b26463cc404eed80c3bbdf37abb522", "OS Family": "Other", "Browser": "Other", "User Agent Version": "5.0", "API Name": "2804", "User Agent Name": "Mozilla", "Request Outcome": "PROCESSED", "Resource Path": "/api/teams", "API Version": "3100" } ]

Get Environments By Envid Events getEnvironmentsByEnvidEvents

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Queries for HTTP events that cab be exported in either JSON or CSV format.
This query is performed against a specific environment whose ID is included as part of the URL.

Path Parameters

envId *: string

Query Parameters

format *: string
Either csv or json. This determines the format in which the events will be exported from the API.
duration: string
apiVersionIds: string
endDate: string(date-time)
Date and time, as defined by the ISO 8601 standard
maxResults: integer
Maximum number of events to be included in the response. Default and maximum allowed value is 20000.
pathPrefix: string
Filter results by event resource path, used when reporting against a particular REST resource root
fields: string
apiIds: string
Comma-delimited list of API IDs that will be included as part of the query. Omit or specify 'all' or '*' to include all APIs.
startDate: string(date-time)
Date and time, as defined by the ISO 8601 standard

Response

Successful operation.
Examples
*/*
[ { "OS Family": "Other", "Request Outcome": "PROCESSED", "API Version": "3100", "Browser": "Other", "Status Code": 200, "Application": "45b26463cc404eed80c3bbdf37abb522", "Resource Path": "/api/teams", "API Name": "2804", "User Agent Version": "5.0", "Hardware Platform": "Other", "User Agent Name": "Mozilla", "Verb": "GET" } ]