Search + K

Command Palette

Search for a command to run...

Sign In

Query audit logs

GET /cms/v3/audit-logs/
Copy endpoint
https://api.hubapi.com

Returns audit logs based on filters.

Parameters

query Query Parameters

Name Type
after

Timestamp after which audit logs will be returned

string
before

Timestamp before which audit logs will be returned

string
eventType

Comma separated list of event types to filter by (CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED).

string[]
limit

The number of logs to return.

number
objectId

Comma separated list of object ids to filter by.

string[]
objectType

Comma separated list of object types to filter by (BLOG, LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.)

string[]
sort

The sort direction for the audit logs. (Can only sort by timestamp).

string[]
userId

Comma separated list of user ids to filter by.

string[]

Responses

200 application/json

successful operation

interface CollectionResponsePublicAuditLog {
paging?: Paging2
interface Paging2 {
next?: NextPage3;
prev?: PreviousPage2;
}
;
results: PublicAuditLog
interface PublicAuditLog {
event: "CREATED" | "DELETED" | "PUBLISHED" | "RESTORE" | "UNPUBLISHED" | "UPDATED";
fullName: string;
meta?: {};
objectId: string;
objectName: string;
objectType: "BLOG" | "BLOG_POST" | "CONTENT_SETTINGS" | "CSS" | "CTA" | "DOMAIN" | "EMAIL" | "FILE" | "GLOBAL_MODULE" | "HUBDB_TABLE" | "JS" | "KNOWLEDGE_BASE" | "KNOWLEDGE_BASE_ARTICLE" | "LANDING_PAGE" | "MODULE" | "SERVERLESS_FUNCTION" | "TEMPLATE" | "THEME" | "URL_MAPPING" | "WEBSITE_PAGE";
timestamp: string;
userId: string;
}
[]
;
}
default */*

An error occurred.

interface Error {
category: string;
context?: { };
correlationId: string;
errors?: ErrorDetail
interface ErrorDetail {
code?: string;
context?: { };
in?: string;
message: string;
subCategory?: string;
}
[]
;
links?: { };
message: string;
subCategory?: string;
}