Jump to

• Request
• Response

createClickstreamRequest

post

/ccagent/v1/personalDataReports/requests

Request a clickstream history report for a given shopper.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createClickstreamRequest_request

Type: object

Show Source

• shopperId: string
  Profile ID of shopper for which report will be generated
• time(optional): integer
  Length of time in number of months, default 12

{
    "properties":{
        "shopperId":{
            "description":"Profile ID of shopper for which report will be generated",
            "type":"string"
        },
        "time":{
            "description":"Length of time in number of months, default 12",
            "type":"integer"
        }
    },
    "required":[
        "shopperId"
    ],
    "example":{
        "shopperId":"11001",
        "time":6
    }
}

Example:

{
    "shopperId":"11001",
    "time":6
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

ID and information about requested clickstream report

Body ()

Root Schema : clickstreamReportRecord

Type: object

Show Source

• 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)

{
    "properties":{
        "agentId":{
            "description":"ID of agent who requested the report",
            "type":"string"
        },
        "requestCreationTime":{
            "description":"Time at which report request was received",
            "type":"string"
        },
        "reportCreationTime":{
            "description":"Time of report creation",
            "type":"string"
        },
        "downloadURL":{
            "description":"URL where report can be downloaded when ready",
            "type":"string"
        },
        "id":{
            "description":"Generated report ID",
            "type":"string"
        },
        "key":{
            "description":"Key to be used for decryption of report",
            "type":"string"
        },
        "status":{
            "description":"Status of report (PENDING, DELIVERED, DELETED)",
            "type":"string"
        }
    }
}

Default Response

Error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top