Skip to main content
POST
List raw captured clicks

Restrictions

Usage

  • start_time and end_time are Unix epoch milliseconds. Omit both to use the last 7 days; a range wider than 14 days returns InvalidParameter.
  • The caller needs read access to application_id; data of private applications the caller cannot access is not counted.
  • only_unclassified=true hides groups a saved event already matches, which is what is left to define.
  • Groups are merged across selectors by element name; selectors lists up to 10 of them.
  • sample_rate reports the share of sessions read, 1 when exact; clicks, visitors, frustrated and error_clicks are scaled up to the whole range.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

List autocaptured clicks grouped by page and element name.

application_id
string
required

RUM application ID. The caller needs read access to it; for write operations, manage access.

end_time
integer<int64>

End of the window, Unix timestamp in milliseconds. Defaults to now when omitted.

Example:

1780358400000

limit
integer
default:100

Maximum groups to return. 1-200, default 100.

Required range: 1 <= x <= 200
only_unclassified
boolean

When true, return only groups no saved event matches yet.

start_time
integer<int64>

Start of the window, Unix timestamp in milliseconds. Omit both bounds to use the last 7 days; a range wider than 14 days is rejected.

Example:

1780272000000

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Grouped autocaptured clicks and the share of traffic the query read.