HomeDocumentation and Guides
Home

Entities Endpoint

The entities API returns data for asset list page and asset list exports.

Fields

Field NameTypeDescriptionPossible Values
idstringunique internal identifier for the asset
vendorvendor resource
origin_idstringunique identifier for the asset provided by the origin platform/vendor
origin_typestringequivalent to vendor_typedocument, post, event, app, site
asset_typestringgoogle_document, google_spreadsheet, google_form, google_drawing, google_presentation, google_site, folder, non_native_file, pdf
ownerslist of permission resources (see below)permissions corresponding to the owner(s) of the asset
mime_typestring
exposurestringexposure level of the documentpublic, externally shared, organization-wide, internally shared, private
collaborators_countintegertotal number of collaborators on an asset
namestringtitle, name of the asset
sizeintegersize of the asset in bytes
updated_attimestampthe last time the asset has been modified, in UTC
created_attimestampthe time at which the asset was created, in UTC
direct_urlstringURL to the asset
collaboratorslist of permission resources (see below)permissions corresponding to the collaborators on an asset

Permission Resource

Field NameTypeDescriptionPossible Value
typestringtype of permission(current values are Google specific)
rolestringrole associated with the permission (current values are Google specific)reader, writer, owner
valuestringemail address or domain address for the permission[email protected]

Filters

Filter NameDescriptionPossible ValuesExample
platformThe application supplying the underlying data (i.e. Google Drive, Google Sites). platform value should be in the format: _<origin_type>"google_document", "google_site"
ownerscomma delimited list of owner email addresses
exposureexposure level of the documentpublic, externally shared, organization-wide, internally shared, private
asset_typegoogle_document, google_spreadsheet, google_presentation, google_form, google_drawing, google_site, google_plus_post (future), google_non_native_file, pdf, folder
mime_typespreadsheet (.xlsx, application/vnd-google-apps.spreadsheet), document (.docx, application/vnd-google-apps.document)
updated_beforeFilters assets updated before the specified timestamptimestamp
updated_afterFilters assets updated after the specified timestamptimestamp

Entities

[/entities]
List entities [GET]

  • Response 200 (application/json)
{
   "limit": 10,
   "offset": 0,
   "total": 1520,
   "results": 10,
   "items": [{
     "collaborators": [],
     "vendor": "google",
     "name": "Domain-wide Share 3/15/16",
     "exposure": "organization_wide",
     "asset_type": "google_document",
     "created_at": "2016-03-15T14:27:33.013000+00:00",
     "origin_id": "15RvNK8Ahz_kiszqfs3oLopOAGUxZyBRi5_yAIyo5ans",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-15T14:28:03.909000+00:00",
     "mime_type": "application/vnd.google-apps.document",
     "collaborators_count": 0,
     "direct_url": "https://docs.google.com/a/cloudlocktest.com/document/d/15RvNK8Ahz_kiszqfs3oLopxZyBRi5_yAIyo5ans/edit?usp=drivesdk",
     "id": "MxylKdo1b4",
     "origin_type": "document",
     "size": null
   }, {
     "collaborators": [],
     "vendor": "google",
     "name": "03/15/2016 09:02 - Cloudlock Documents Export [Domain Wide Exposures]",
     "exposure": "private",
     "asset_type": "non_native_file",
     "created_at": "2016-03-15T13:02:42.335000+00:00",
     "origin_id": "0B-79pP5WB3sWMkFVNGFleGtjc00",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-15T13:02:42.335000+00:00",
     "mime_type": "text/csv",
     "collaborators_count": 0,
     "direct_url": "https://drive.google.com/a/cloudlocktest.com/file/d/0B-79pP5WBkFVNGFleGtjc00/view?usp=drivesdk",
     "id": "MxylKK5pr4",
     "origin_type": "document",
     "size": "263"
   }, {
     "collaborators": [],
     "vendor": "google",
     "name": "Copy of 100Test9March2016.docx",
     "exposure": "private",
     "asset_type": "non_native_file",
     "created_at": "2016-03-15T10:05:30.131000+00:00",
     "origin_id": "0B-79pP5WB3sWTm14QS1MbW5hRXc",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-15T10:05:29.665000+00:00",
     "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
     "collaborators_count": 0,
     "direct_url": "https://drive.google.com/a/cloudlocktest.com/file/d/0B-79pP5WB3sWTm14bW5hRXc/view?usp=drivesdk",
     "id": "O3ZXvLYddx",
     "origin_type": "document",
     "size": "9283"
   }, {
     "collaborators": [],
     "vendor": "google",
     "name": "03/14/2016 21:39 - Cloudlock Documents Export [External Exposures]",
     "exposure": "private",
     "asset_type": "non_native_file",
     "created_at": "2016-03-15T01:39:43.769000+00:00",
     "origin_id": "0B-79pP5WB3sWb3R4OXdJSG44dWM",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-15T01:39:43.769000+00:00",
     "mime_type": "text/csv",
     "collaborators_count": 0,
     "direct_url": "https://drive.google.com/a/cloudlocktest.com/file/d/0B-79pP5WB3sWbXdJSG44dWM/view?usp=drivesdk",
     "id": "L4dDNowOG4",
     "origin_type": "document",
     "size": "263"
   }, {
     "collaborators": [],
     "vendor": "google",
     "name": "03/14/2016 21:27 - Cloudlock Documents Export [External Exposures]",
     "exposure": "private",
     "asset_type": "non_native_file",
     "created_at": "2016-03-15T01:27:42.326000+00:00",
     "origin_id": "0B-79pP5WB3sWY3VRbXFRRVdxUTQ",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-15T01:27:42.326000+00:00",
     "mime_type": "text/csv",
     "collaborators_count": 0,
     "direct_url": "https://drive.google.com/a/cloudlocktest.com/file/d/0B-79pP5WB3sWY3VRbVdxUTQ/view?usp=drivesdk",
     "id": "9zMXEAjZXx",
     "origin_type": "document",
     "size": "878"
   }, {
     "collaborators": [{
       "role": "writer",
       "type": "user",
       "name": "Admin Admin",
       "value": "[email protected]"
     }],
     "vendor": "google",
     "name": "External Doc 3/14 15:39",
     "exposure": "external",
     "asset_type": "google_document",
     "created_at": "2016-03-14T19:28:57.526000+00:00",
     "origin_id": "1iV-m2OBEU_ez7IHY4dD_CkgpvCXh_bvZlUEcBpqysKw",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "User Four",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-14T19:29:41.243000+00:00",
     "mime_type": "application/vnd.google-apps.document",
     "collaborators_count": 1,
     "direct_url": "https://docs.google.com/a/cloudlocktest.com/document/d/1iV-m2OBEU_ez7dD_CkgpvCXh_bvZlUEcBpqysKw/edit?usp=drivesdk",
     "id": "O3ZX7PgORx",
     "origin_type": "document",
     "size": null
   }, {
     "collaborators": [{
       "role": "writer",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }, {
       "role": "writer",
       "type": "group",
       "name": "Group with External",
       "value": "[email protected]"
     }],
     "vendor": "google",
     "name": "look, I'm shared externally!",
     "exposure": "external",
     "asset_type": "google_document",
     "created_at": "2016-02-04T21:57:09.253000+00:00",
     "origin_id": "1byhEs8PatoyPYwaY6PvfQe7gNQ-NuQhYmG_BdV5daM8",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-14T14:28:06.007000+00:00",
     "mime_type": "application/vnd.google-apps.document",
     "collaborators_count": 2,
     "direct_url": "https://docs.google.com/a/cloudlocktest.com/document/d/1byhEs8PatoyP6PvfQe7gNQ-NuQhYmG_BdV5daM8/edit?usp=drivesdk",
     "id": "MxyvNVj9rz",
     "origin_type": "document",
     "size": null
   }, {
     "collaborators": [],
     "vendor": "google",
     "name": "random.doc",
     "exposure": "private",
     "asset_type": "non_native_file",
     "created_at": "2016-03-14T14:16:21.037000+00:00",
     "origin_id": "0B-79pP5WB3sWVW5mcklqUlR6SjA",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-14T14:16:21.037000+00:00",
     "mime_type": "application/msword",
     "collaborators_count": 0,
     "direct_url": "https://drive.google.com/a/cloudlocktest.com/file/d/0B-79pP5WB3sWVWlqUlR6SjA/view?usp=drivesdk",
     "id": "Mxylr7AX64",
     "origin_type": "document",
     "size": "2582485"
   }, {
     "collaborators": [],
     "vendor": "google",
     "name": "03/14/2016 09:02 - Cloudlock Documents Export [Domain Wide Exposures]",
     "exposure": "private",
     "asset_type": "non_native_file",
     "created_at": "2016-03-14T13:02:40.022000+00:00",
     "origin_id": "0B-79pP5WB3sWTFc0UHBib3J1X3M",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-14T13:02:40.022000+00:00",
     "mime_type": "text/csv",
     "collaborators_count": 0,
     "direct_url": "https://drive.google.com/a/cloudlocktest.com/file/d/0B-79pP5WB3sWTFc0U3J1X3M/view?usp=drivesdk",
     "id": "RzEjObPED3",
     "origin_type": "document",
     "size": "263"
   }, {
     "collaborators": [],
     "vendor": "google",
     "name": "03/13/2016 15:17 - Cloudlock Documents Export [External Exposures]",
     "exposure": "private",
     "asset_type": "non_native_file",
     "created_at": "2016-03-13T19:17:44.232000+00:00",
     "origin_id": "0B-79pP5WB3sWbFJ1ZVhiUUZ3SG8",
     "owners": [{
       "role": "owner",
       "type": "user",
       "name": "James Smith",
       "value": "[email protected]"
     }],
     "updated_at": "2016-03-13T19:17:44.232000+00:00",
     "mime_type": "text/csv",
     "collaborators_count": 0,
     "direct_url": "https://drive.google.com/a/cloudlocktest.com/file/d/0B-79pP5WB3sWbVhiUUZ3SG8/view?usp=drivesdk",
     "id": "R4RXYgWXoz",
     "origin_type": "document",
     "size": "263"
   }]
 }