Attributable iFrames

The Attributable iFrames allow for the display of Attributable dashboard data on an external website. Although iframes are protected by a different access key than the Attributable APIs and display less information than can be consumed through the Attributable website, it's nonetheless strongly recommended that the ability to view Attributable iFrame content be restricted to authenticated administrators. iFrame keys are private, unique and application-specific.

Like the APIs, the iFrames are a continual work in progress, so as new versions of the iframes become available, old versions will be retired (after a suitable transition period). In general, sub-incremental versions are forwards-compatible (e.g. 1.2 will accept the same parameters as 1.1), but incremental versions will not (e.g. 2.0 will require different configuration than 1.0).




Events iFrame

The Events iFrame can be used to display a timeline of filtered event data.

URL Structure

https://iframe.attributables.com/1-0/ IFRAME KEY /events/ INPUT PARAMETERS 

Input parameters are expressed in the URL as key-value pairs delimited by pipes ("|"), e.g.

/user_id=123|tag_key=company_id|tag_value=abc

Input Parameters

Field Data type Format Restricted to Comments
user_id Alphanumeric
tag_key Alphanumeric Requires tag_value
tag_value Alphanumeric Requires tag_key
start_date Datetime YYYY-MM-DD HH:MM:SS
end_date Datetime YYYY-MM-DD HH:MM:SS
is_alert Boolean 1 or 0
is_resolved Boolean 1 or 0
rows Integer Number of rows to display in iframe