Content Access

Content access report provides the content access metrics like total access, total duration, total completion etc., content id wise. If the response is not successful, the appropriate error response returns.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Organization UUID

Body Params

The configuration to create request handle is supplied in the request body

date-time

Start date for events retrieval

date-time

End date for events retrieval

string
enum

To calculate the start/end date dynamically based on timeframe and when the report is submitted date. [User can submit an absolute date range (start/end date) or a relative date range (timeframe) but never both]

Allowed:
string
Defaults to ALL

Audience filter, defaults to all audience

string

The field to use for specifying language. Will default to all when not specified. example format 'en-US' or 'fr-FR' or 'de-DE' etc.

string
Defaults to ALL

Collections used for content lookup, comma delimited and defaults to all collections

string

Content types filter, comma delimited and default to all content types

sort
object

The field to use for sorting and which order to sort in, if sort is not included the results will be returned descending by total accesses

string
enum

Content access status filter, defaults to all status type

Allowed:
uuid

SFTP Id associated with OrgId

boolean
Defaults to true

Generated files are required to deliver in the respected sftp location. Default value is true.

boolean
Defaults to false

Generate the reports in zip file format. Default value is false.

boolean
Defaults to false

Generate the report file as PGP encrypted file. Default value is false.

boolean
Defaults to false

If the file that need to be ecncrypted should not include a extension of .pgp at the end of the file name, the value should be set to true. If user sets the value as false or doesn't include the flag a .pgp extension will be appended at the end of file name.

string
enum
Defaults to JSON

Format Type, defaults to JSON, the value is extracted from Accept attribute in header

Allowed:
string

Absolute or masked pattern for the generated report file. Example file masks - fileName_{DD}{MM}{YYYY}, fileName_{ORG_ID}

string

custom folder under sftp reports wherein the generated report file is to be placed.

boolean
Defaults to false

Generate files with unix based timestamp. Example - fileName.csv.1561642446608

Responses

400

Bad Request

401

Unauthorized

422

Unprocessable Entity

500

Unexpected error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json