Permalink
Switch branches/tags
Find file Copy path
165 lines (118 sloc) 5.88 KB

AMP Access and Analytics

Access analytics triggers

Access service issues events for major states in the access flow. These events can be reported through the analytics configuration by using triggers.

See amp-analytics.md for details on amp-analytics configuration.

Authorization received trigger ("on": "access-authorization-received")

The access-authorization-received event is issued when the Authorization endpoint has succeeded. Use these configurations to fire a request for this event.

"triggers": {
  "accessAuthorizationReceived": {
    "on": "access-authorization-received",
    "request": "event"
  }
}

Authorization received trigger ("on": "access-authorization-failed")

The access-authorization-failed event is issued when the Authorization endpoint has failed. Use these configurations to fire a request for this event.

"triggers": {
  "accessAuthorizationFailed": {
    "on": "access-authorization-failed",
    "request": "event"
  }
}

Access view registered trigger ("on": "access-viewed")

The access-viewed event is issued when the access system considers the page viewed and right before pingback is sent. Use these configurations to fire a request for this event.

"triggers": {
  "accessViewed": {
    "on": "access-viewed",
    "request": "event"
  }
}

Pingback sent trigger ("on": "access-pingback-sent")

The access-pingback-sent event is issued when the Pingback endpoint has succeeded. Use these configurations to fire a request for this event.

"triggers": {
  "accessPingbackSent": {
    "on": "access-pingback-sent",
    "request": "event"
  }
}

Pingback failed trigger ("on": "access-pingback-failed")

The access-pingback-failed event is issued when the Pingback endpoint has failed. Use these configurations to fire a request for this event.

"triggers": {
  "accessPingbackFailed": {
    "on": "access-pingback-failed",
    "request": "event"
  }
}

Login started trigger ("on": "access-login[-type]-started")

The access-login[-type]-started event is issued right before the Login dialog has been opened. Use these configurations to fire a request for this event.

When only one Login URL is configured, the event is access-login-started. When multiple Login URLs are configured, the event is access-login-type-started, e.g. "access-login-signup-started". See Login Page Spec for more info.

"triggers": {
  "accessLoginStarted": {
    "on": "access-login-started",
    "request": "event"
  }
}

Login success trigger ("on": "access-login[-type]-success")

The access-login[-type]-success event is issued when Login dialog has succeeded. Use these configurations to fire a request for this event.

When only one Login URL is configured, the event is access-login-success. When multiple Login URLs are configured, the event is access-login-type-success, e.g. "access-login-signup-success". See Login Page Spec for more info.

"triggers": {
  "accessLoginSuccess": {
    "on": "access-login-success",
    "request": "event"
  }
}

Login rejected trigger ("on": "access-login[-type]-rejected")

The access-login[-type]-rejected event is issued when Login dialog has been rejected by the user. Use these configurations to fire a request for this event.

When only one Login URL is configured, the event is access-login-rejected. When multiple Login URLs are configured, the event is access-login-type-rejected, e.g. "access-login-signup-rejected". See Login Page Spec for more info.

"triggers": {
  "accessLoginRejected": {
    "on": "access-login-rejected",
    "request": "event"
  }
}

Login failed trigger ("on": "access-login[-type]-failed")

The access-login[-type]-failed event is issued when Login dialog has failed due to an unknown reason. Use these configurations to fire a request for this event.

When only one Login URL is configured, the event is access-login[-type]-failed. When multiple Login URLs are configured, the event is access-login-type-failed, e.g. "access-login-signup-failed". See Login Page Spec for more info.

"triggers": {
  "accessLoginFailed": {
    "on": "access-login-failed",
    "request": "event"
  }
}

Access analytics variables

Access contributes the following URL substitutions to the amp-var-substitutions.md.

ACCESS_READER_ID

The ACCESS_READER_ID variable is substituted with the Reader ID used for access operations. This is a sensitive ID and care should be taken in sharing it. Please ensure that any data you pass to a third party complies with its terms of service.

AUTHDATA(field)

The AUTHDATA(field) variable is substituted with the value of the field in the authorization response. The nested fields are allowed, such as AUTHDATA(nested.field).

This variable will wait until authorization is complete before being available.

Data contained in AUTHDATA may be sensitive and care should be taken in sharing it. Please ensure that any data you pass to a third party complies with its terms of service.