• Document Up to Date

Get User Activity

Get user activity for a site (My recent activity dashboard).

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /studio, please prefix the API URLs with this context.

HTTP Verb
GET
URL
/api/1/services/api/1/activity/get-user-activities.json
Response Formats
JSON
Required Role
member of site

Parameters

Name
Type
Required
Description
site_id
String
✓
Site to use
num
Integer
✓
Number of records to retrieve
excludeLive
Boolean
✓
Exclude live items from result set
filterType
String
✓
Filter type

Example

Request

GET .../api/1/services/api/1/activity/get-user-activities.json?site_id=mysite&num=10&excludeLive=false&filterType=all``

Response

Status 200 OK

  1{
  2  total: 1,
  3  sortedBy: "eventDate",
  4  ascending: "false",
  5  documents:
  6    [
  7      {
  8        name: "index.xml",
  9        internalName: "Home",
 10        contentType: "/page/home",
 11        uri: "/site/website/index.xml",
 12        path: "/site/website",
 13        browserUri: "",
 14        navigation: false,
 15        floating: true,
 16        hideInAuthoring: false,
 17        previewable: true,
 18        lockOwner: "",
 19        user: "admin",
 20        userFirstName: "admin",
 21        userLastName: "",
 22        nodeRef: null,
 23        metaDescription: null,
 24        site: "documentation",
 25        page: true,
 26        component: false,
 27        document: false,
 28        asset: false,
 29        isContainer: false,
 30        container: false,
 31        disabled: false,
 32        savedAsDraft: false,
 33        submitted: false,
 34        submittedForDeletion: false,
 35        scheduled: false,
 36        published: true,
 37        deleted: false,
 38        inProgress: true,
 39        live: false,
 40        inFlight: false,
 41        isDisabled: false,
 42        isSavedAsDraft: false,
 43        isInProgress: true,
 44        isLive: false,
 45        isSubmittedForDeletion: false,
 46        isScheduled: false,
 47        isPublished: false,
 48        isNavigation: false,
 49        isDeleted: false,
 50        isNew: false,
 51        isSubmitted: false,
 52        isFloating: false,
 53        isPage: true,
 54        isPreviewable: true,
 55        isComponent: false,
 56        isDocument: false,
 57        isAsset: false,
 58        isInFlight: false,
 59        eventDate: "2017-07-05T21:32:02+02:00",
 60        endpoint: null,
 61        timezone: null,
 62        numOfChildren: 0,
 63        scheduledDate: null,
 64        publishedDate: "2017-07-05T21:29:08+02:00",
 65        mandatoryParent: null,
 66        isLevelDescriptor: false,
 67        categoryRoot: null,
 68        lastEditDate: "2017-07-05T21:32:02+02:00",
 69        form: "/page/home",
 70        formPagePath: "simple",
 71        renderingTemplates:
 72          [
 73            {
 74              uri: "/templates/web/pages/home.ftl",
 75              name: "DEFAULT"
 76            }
 77          ],
 78        folder: false,
 79        submissionComment: null,
 80        components: null,
 81        documents: null,
 82        levelDescriptors: null,
 83        pages: null,
 84        parentPath: null,
 85        orders:
 86          [
 87            {
 88              name: null,
 89              id: "default",
 90              disabled: null,
 91              placeInNav: null,
 92              order: -1
 93            }
 94          ],
 95        children: [ ],
 96        size: 0,
 97        sizeUnit: null,
 98        mimeType: "application/xml",
 99        newFile: false,
100        levelDescriptor: false,
101        reference: false,
102        new: false
103      }
104    ]
105}

Responses

Status
Location
Response Body
200

See example above.