HubSpot: Content audit schemas

← Content audit operations · All schemas

Export Logs — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	A string specifying the email address to which notifications about the export should be sent.
filters	Model	Optional	Expand Export Logs — request body — body filters
format	string	Required within parent	A string specifying the format of the export file. Valid values include 'XLS', 'XLSX', and 'CSV'. One of: CSV, XLS, XLSX
partition	integer	Optional	An integer used for partitioning the export data, if applicable. Format: int32
portalId	integer	Required within parent	An integer representing the ID of the portal from which the audit logs are being exported. Format: int32
recipientUserIds	array	Required within parent	An array of integers specifying the IDs of users who should receive the exported file.
recipientUserIds[]	integer	Each item	Format: int32
shouldMarkExportFileAsSensitive	boolean	Required within parent	A boolean indicating whether the export file should be marked as sensitive.
type	string	Required within parent	A string indicating the type of export being performed.
userId	integer	Optional	An integer representing the ID of the user initiating the export. Format: int32
userTimeZone	string	Optional	A string representing the time zone of the user initiating the export.

Referenced models: Export Logs — request body — body filters

Export Logs — request body — body filters

Field	Type	Presence	Description and constraints
$	object	Root
objectType	array	Required within parent	An array of strings representing the types of objects to filter by during the export. Valid object types include 'BLOG', 'BLOG_POST', 'LANDING_PAGE', 'WEBSITE_PAGE', 'TEMPLATE', 'MODULE', 'GLOBAL_MODULE', 'SERVERLESS_FUNCTION', 'DOMAIN', 'URL_MAPPING', 'EMAIL', 'CONTENT_SETTINGS', 'HUBDB_TABLE', 'KNOWLEDGE_BASE_ARTICLE', 'KNOWLEDGE_BASE', 'THEME', 'CSS', 'JS', 'CTA', 'FILE', 'WEB_INTERACTIVE', 'PODCAST', 'CASE_STUDY', and 'QUOTE'.
objectType[]	string	Each item

Retrieve logs — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve logs — response body — paging
results	array	Required within parent	An array of PublicAuditLog objects, each representing a single audit log entry.
results[]	Model	Each item	Expand Retrieve logs — response body — results item

Referenced models: Retrieve logs — response body — paging, Retrieve logs — response body — results item

Retrieve logs — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Retrieve logs — response body — paging next
prev	Model	Optional	Expand Retrieve logs — response body — paging prev

Referenced models: Retrieve logs — response body — paging next, Retrieve logs — response body — paging prev

Retrieve logs — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	Cursor token representing the boundary timestamp after which to fetch the next page of results. Pass this value as the after query parameter to retrieve later audit logs.
link	string	Optional	Pre-constructed URL that can be used to directly fetch the next page of results without manually building the query.

Retrieve logs — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	Pre-constructed URL that can be used to directly fetch the previous page of results without manually building the query.
link	string	Optional	Cursor token representing the boundary timestamp before which to fetch the previous page of results. Pass this value as the before query parameter to retrieve earlier audit logs.

Retrieve logs — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
event	string	Required within parent	The type of event that took place (CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED). Known values: CREATED, DELETED, PUBLISHED, RESTORE, UNPUBLISHED, UPDATED
fullName	string	Required within parent	The name of the user who caused the event.
meta	object	Required within parent	Supplementary metadata associated with the audit log entry. It provides additional context about the audited event (ex: rows deleted/updated for a HubDB event, the specific fields that were changed for a Content Settings event).
objectId	string	Required within parent	The ID of the object.
objectName	string	Required within parent	The internal name of the object in HubSpot.
objectType	string	Required within parent	The type of the object (BLOG, LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.) Known values: BLOG, BLOG_POST, CASE_STUDY, CONTENT_SETTINGS, CSS, CTA, DOMAIN, EMAIL, FILE, GLOBAL_MODULE, HUBDB_TABLE, JS, KNOWLEDGE_BASE, KNOWLEDGE_BASE_ARTICLE, LANDING_PAGE, MODULE, PODCAST, QUOTE, SERVERLESS_FUNCTION, TEMPLATE, THEME, URL_MAPPING, WEB_INTERACTIVE, WEBSITE_PAGE
timestamp	string	Required within parent	The timestamp at which the event occurred. Format: date-time
userId	string	Required within parent	The ID of the user who caused the event.