lumis.service.analytics.usersegmentation.rest

Class UserSegmentationRestAPI

java.lang.Object

lumis.service.analytics.usersegmentation.rest.UserSegmentationRestAPI

@Path(value="/lumis/service/analytics/usersegmentation/{si:[a-fA-F0-9]{32}}/rest")
public class UserSegmentationRestAPI
extends Object

User segmentation resource.

Since:

11.0.0

Version:

$Revision: 23745 $ $Date: 2020-04-07 23:09:15 +0000 (Tue, 07 Apr 2020) $

Constructor Summary

Constructors

Constructor and Description
UserSegmentationRestAPI()

Method Summary

Modifier and Type	Method and Description
static void	addUsersActivityFilters(List<ISearchQueryFilter> filters) Put filter for user activity list.
void	anonymizeMonitorUser(String visitorId) Anonymize the monitor user with the given visitorId.
void	deleteMonitorUser(String visitorId) Delete the monitor user with the given visitorId.
void	deleteMonitorUserActivities(String visitorId) Delete the activities of the monitor user with the given visitorId.
Response	downloadSegmentationCSV(String jsonData, List<String> fields, Character columnSeparator) Returns a CSV file containing the users in a given segmentation list.
Response	getNextActivities(String visitorId, Integer page, Long firstEventDateMilli, lumis.service.analytics.usersegmentation.rest.UserSegmentationRestAPI.NextActivitiesRequest bodyRequest) Returns only activities of user for be appended in the activities of user.
static List<FieldReportCSV>	getOrderedFieldsReportCSV(List<String> requestFieldCodes) Receive a list of request fields like "_userAttribue_:" or "", then, return a ordered list of {link FieldReportCSV}
Response	getSegmentation(String id) Return segmentation by id.
Response	getSegmentations(String name) Returns the segmentations list.
Response	getUserDetails(String visitorId) Returns the user details.
void	getUserInfoTXT(String visitorId, String activities, HttpServletResponse response) Returns the user details.
Response	getUsers(String jsonData, int maxSize, int startAt) Returns the users list based on the given filters.
static org.json.JSONObject	parseToJsonObject(UserSegmentation userSegmentation) Receives a entity and returns a json client format.
Response	saveSegmentation(String body, String id) Quick save operation for segmentation.
Response	updateMonitorUserAttributes(long visitorId, String saveType, String reqData) Update monitor user attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserSegmentationRestAPI

public UserSegmentationRestAPI()

Method Detail

getUsers

@Path(value="/users")
 @POST
 @Produces(value="application/json")
public Response getUsers(@FormParam(value="filters")
                                                                                           String jsonData,
                                                                                           @FormParam(value="maxSize") @DefaultValue(value="50") @Min(value=1L) @Max(value=50L)
                                                                                           int maxSize,
                                                                                           @FormParam(value="startAt") @Min(value=1L) @DefaultValue(value="1")
                                                                                           int startAt)
                                                                                    throws PortalException

Returns the users list based on the given filters.

Parameters:

jsonData - the JSON data of applied filters.

maxSize - the maximum number of hits of the query.

startAt - the number of first hit of the query.

serviceInstanceId - the service instance identifier.

Returns:

the users list based on the given filters.

Throws:

PortalException

Since:

11.0.0

downloadSegmentationCSV

@Path(value="/users/csv")
 @POST
 @Produces(value="text/csv")
public Response downloadSegmentationCSV(@FormParam(value="filters")
                                                                                                      String jsonData,
                                                                                                      @FormParam(value="field")
                                                                                                      List<String> fields,
                                                                                                      @FormParam(value="columnSeparator") @DefaultValue(value=";")
                                                                                                      Character columnSeparator)
                                                                                               throws PortalException

Returns a CSV file containing the users in a given segmentation list.

Parameters:

jsonData - the JSON data of applied filters in the segmentation.

fields - the service instance identifier.

Returns:

the users list based on the given filters.

Throws:

PortalException

Since:

11.1.0

getUserDetails

@Path(value="/user/{visitorId}")
 @GET
 @Produces(value="application/json")
public Response getUserDetails(@PathParam(value="visitorId")
                                                                                                           String visitorId)
                                                                                                    throws PortalException

Returns the user details.

Parameters:

jsonData - the JSON data of applied filters.

Returns:

the users list based on the given filters.

Throws:

PortalException

Since:

11.0.0

getUserInfoTXT

@Path(value="/user/{visitorId}/user.txt")
 @GET
 @Produces(value="application/json")
public void getUserInfoTXT(@PathParam(value="visitorId")
                                                                                                                String visitorId,
                                                                                                                @QueryParam(value="activities")
                                                                                                                String activities,
                                                                                                                @Context
                                                                                                                HttpServletResponse response)

Returns the user details.

Parameters:

jsonData - the JSON data of applied filters.

Since:

12.3.0

getNextActivities

@Path(value="/user/{visitorId}/activities/{page}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public Response getNextActivities(@PathParam(value="visitorId")
                                                                                                                                                                      String visitorId,
                                                                                                                                                                      @PathParam(value="page")
                                                                                                                                                                      Integer page,
                                                                                                                                                                      @QueryParam(value="firstEventDateMilliseconds")
                                                                                                                                                                      Long firstEventDateMilli,
                                                                                                                                                                      lumis.service.analytics.usersegmentation.rest.UserSegmentationRestAPI.NextActivitiesRequest bodyRequest)
                                                                                                                                                               throws PortalException

Returns only activities of user for be appended in the activities of user.

Parameters:

visitorId - the visitor user identifier.

page - the page of pagination.

firstEventDateMilli - the oldest event date time in the top of event activities list. It avoids to newest events mess up the pagination.

Returns:

the next block of activities.

Throws:

PortalException

Since:

12.1.0

addUsersActivityFilters

public static void addUsersActivityFilters(List<ISearchQueryFilter> filters)
                                    throws PortalObjectNotFoundException

Put filter for user activity list. We have this list in user segmentation and event analytics graph.

Parameters:

filters - the filter list to receive more filters.

Throws:

PortalObjectNotFoundException

Since:

12.2.0

saveSegmentation

@Path(value="/segmentation/{id:[a-fA-F0-9]{32}}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response saveSegmentation(String body,
                                                                                                                                                                   @PathParam(value="id") @NotBlank
                                                                                                                                                                   String id)

Quick save operation for segmentation.

Parameters:

segmentationFilter - the segmentation filter.

id - the segmentation identifier.

Returns:

the response.

Throws:

PortalException

Since:

11.1.0

getSegmentation

@Path(value="/segmentation/{id:[a-fA-F0-9]{32}}")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response getSegmentation(@PathParam(value="id") @NotBlank
                                                                                                                                                                  String id)

Return segmentation by id.

Parameters:

id - the segmentation identifier.

Returns:

the response.

Since:

11.1.0

parseToJsonObject

public static org.json.JSONObject parseToJsonObject(UserSegmentation userSegmentation)

Receives a entity and returns a json client format.

Parameters:

userSegmentation - the entity.

Returns:

the json object.

Since:

11.1.0

getSegmentations

@Path(value="/segmentations")
 @GET
 @Produces(value="application/json")
public Response getSegmentations(@QueryParam(value="name")
                                                                                                          String name)
                                                                                                   throws PortalException

Returns the segmentations list.

Returns:

the response.

Throws:

PortalException

Since:

11.1.0

getOrderedFieldsReportCSV

public static List<FieldReportCSV> getOrderedFieldsReportCSV(List<String> requestFieldCodes)

Receive a list of request fields like "_userAttribue_:" or "", then, return a ordered list of {link FieldReportCSV}

Parameters:

requestFieldCodes - code for each column field.

Returns:

structured and ordered list fields.

Since:

11.1.0

updateMonitorUserAttributes

@Path(value="/user/{visitorId:\\d+}/attributes/{saveType:(un)?trusted}")
 @POST
 @Consumes(value="application/json")
public Response updateMonitorUserAttributes(@NotNull @PathParam(value="visitorId")
                                                                                                                                                                 long visitorId,
                                                                                                                                                                 @PathParam(value="saveType")
                                                                                                                                                                 String saveType,
                                                                                                                                                                 @NotNull
                                                                                                                                                                 String reqData)
                                                                                                                                                          throws PortalException

Update monitor user attributes. Wrapper for MonitorV1Resource.updateMonitorUser(String, String).

Parameters:

visitorId - the monitor user visitor identifier

reqData - the requested data

Returns:

the response

Throws:

PortalException

Since:

12.0.0

deleteMonitorUser

@Path(value="/user/{visitorId}")
 @DELETE
public void deleteMonitorUser(@NotNull @PathParam(value="visitorId")
                                                                        String visitorId)
                                                                 throws Exception

Delete the monitor user with the given visitorId.

Parameters:

visitorId - the visitor identifier of the monitor user.

Throws:

Exception

Since:

12.3.0

anonymizeMonitorUser

@Path(value="/user/{visitorId}/anonymize")
 @POST
public void anonymizeMonitorUser(@NotNull @PathParam(value="visitorId")
                                                                                   String visitorId)
                                                                            throws Exception

Anonymize the monitor user with the given visitorId.

Parameters:

visitorId - the visitor identifier of the monitor user.

Throws:

Exception

Since:

12.3.0

deleteMonitorUserActivities

@Path(value="/user/{visitorId}/activities")
 @DELETE
public void deleteMonitorUserActivities(@NotNull @PathParam(value="visitorId")
                                                                                             String visitorId)
                                                                                      throws Exception

Delete the activities of the monitor user with the given visitorId.

Parameters:

visitorId - the visitor identifier of the monitor user.

Throws:

Exception

Since:

12.3.0