Segment - PDF export
GET /segments/v2/{bucket}/segment/{uid}/all/pdf
GET
/segments/v2/{bucket}/segment/{uid}/all/pdf
Export a PDF report based on the data from the segment
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” bucket
required
The bucket (client) name
string
Example
example uid
required
Usually the final element in the URI, an alphanumeric unique identifier
string
Example
6305f074683e800f3abe809eQuery Parameters
Section titled “Query Parameters ” template
required
string
policy
string
gdpr_bypass
boolean
gdpr_bypass_reason
string
debug
boolean
Responses
Section titled “ Responses ”A ‘receipt’ for the PDF report request
object
bucket
The bucket (client) name
string
Example
example uid
Usually the final element in the URI, an alphanumeric unique identifier
string
Example
6305f074683e800f3abe809e lambda_prefix
string
policy
string
gdpr_bypass
boolean
gdpr_channel
string
user_uri
The URI of a user account (CRM users will begin with /sheepcrm/ App users with /sheepapp/)
string
Example
/sheepcrm/user/6305f074683e800f3abe809e/ template
string
journal_uri
URIs are unique identifiers for resources in the system,
they are structured as follows /bucket/resource_type/uid/
string
Example
/example/person/6305f074683e800f3abe809e/ use_mapreduce
boolean
report_format
string
debug
boolean
A standard error message
object
description
A human readable description of the error
string
error
A concise error message
string
type
A machine readable error type
string
Authentication error