Retrievals
Here is the Retrievals data model required in daily feed.
Column Name | Description | Format | Comment / Possible values |
|---|---|---|---|
Session ID | Session identifier of a user's visit | VARCHAR | |
Event start date | Date of the retrieval event | DATE | See default file format |
Event start timestamp | Timestamp of the retrieval event | TIMESTAMP | See default file format |
Transaction ID | Unique request transaction ID | VARCHAR | |
Platform ID | Platform identifier | VARCHAR | |
Application ID | Application identifier serving the content | VARCHAR | |
Subscription ID | Refers to a valid subscription of the owner to the content | VARCHAR | |
Content Owner ID | Account having subscribed to the content, must be a parent if an account hierarchy is defined (typical with consortia) | VARCHAR | |
Content Consumer ID | Account accessing the content, a child of the | VARCHAR | |
Article ID | Identifier of the article/chapter (content detail) | VARCHAR | |
Content ID | Identifier of the book/journal main content | VARCHAR | |
Database ID | The database to which the content belongs to | VARCHAR | |
Collection ID | The collection to which the content belongs to | VARCHAR | |
Publisher ID | The publisher ID of the retrieval. | VARCHAR | Publisher at the time of the event recording |
Format ID | Display format of the retrieval/click | INTEGER | Full-text HTML, ... See standard formats list |
Open Access Flag | Is the retrieval an open access? | BOOLEAN | JR1 goa reportSee default file format |
Archive Flag | Is the retrieval from an archived content? | BOOLEAN | JR1a reportSee default file format |
Access Denied | When access is denied, categorized the type of issue | VARCHAR | Counter access denied reports, See Counter documentation: no_license, limit_exceeded, turnaway |
Article In Press Flag | Is the retrieval an article in press? | BOOLEAN | JR5 report, See default file format |
From Search ID | Optional, ID of the search result if coming from, or a flag | VARCHAR | 0|1 if no id exists |
Campus Flag | Is the access performed from a campus | BOOLEAN | For drill down in Publisher Application |
Referrer | Full URL of the referrer | VARCHAR | For drill down in Publisher Application |
User Agent | User Agent string | VARCHAR | For drill down in Publisher Application |
Funding | Any contract information | VARCHAR | For drill down in Publisher Application |
Important
You must send the proper format ids in retrieval events, please download the standard list: inqwell_reference_data.sql