createClickstreamRequest
post
/ccagent/v1/personalDataReports/requests
Request a clickstream history report for a given shopper.
Request
Supported Media Types
- application/json
Root Schema : createClickstreamRequest_request
Type:
Show Source
object
-
shopperId:
string
Profile ID of shopper for which report will be generated
-
time(optional):
integer
Length of time in number of months, default 12
Example:
{
"shopperId":"11001",
"time":6
}
Response
Supported Media Types
- application/json
200 Response
ID and information about requested clickstream report
Root Schema : clickstreamReportRecord
Type:
Show Source
object
-
agentId(optional):
string
ID of agent who requested the report
-
downloadURL(optional):
string
URL where report can be downloaded when ready
-
id(optional):
string
Generated report ID
-
key(optional):
string
Key to be used for decryption of report
-
reportCreationTime(optional):
string
Time of report creation
-
requestCreationTime(optional):
string
Time at which report request was received
-
status(optional):
string
Status of report (PENDING, DELIVERED, DELETED)
Default Response
Error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code