OBJECT
ReportEntity

Saved report or dashboard with its settings, sharing and delivery schedule.
GraphQL Schema definition

type ReportEntity {
# True when the record is protected against deletion because it must always exist 
# in the space. Deleting a record that is not protected can still fail on other 
# checks. Read-only.
isDeleteProtected: Boolean! 
# Unique identifier of entity.
id: ID! 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# User who owns the report or dashboard.
owner: ClientEntity 
# Report folder this report is filed under (default folder when empty).
reportsFolder: ReportFolderEntity 
# Specific record this report is synchronized to. Set only when syncEnabled is 
# true.
syncEntity: ProfileEntity 
# Public access token used in shareable report URLs. Empty when public sharing is 
# not configured for the report.
accessLink: String 
# AI assistant conversation associated with the report (e.g. records of AI-driven 
# report generation).
aiConversation: [AiConversationItem!] 
# Free-text description shown alongside the report.
description: String 
# Name of the entity and its default text representation.
name: String! 
# Id of the owning user.
ownerId: ID! 
# Id of the parent report folder.
reportsFolderId: ID! 
# Report definition (entity, columns, filters, charts, structure). Stored as a 
# JSON document. This payload conforms to the `ReportSettings` JSON Schema: 
# https://api-doc.coevera.com/schemas/ReportSettings.json
settings: ReportSettings! 
# Who besides the owner can access the report: nobody (Private, the default), the 
# users and sales units in sharingClients and sharingUnits (Standard), or all 
# users (AllView to view, AllEdit to also edit).
shareMode: ShareModeEnum 
# Legacy additional sharing options; kept with the record but no longer applied.
shareModeParams: Int 
# When true, name and settings are kept in sync with the linked screen profile; 
# when false, the report is detached from profile sync.
syncEnabled: Boolean 
# Id of the synchronized record.
syncEntityId: ID 
# Kind of report: a table or pivot report, a dashboard, an opportunity forecast, 
# or an advanced report built from several linked tables.
type: ReportTypeEnum! 
# Revision when entity was lastly changed.
revision: Int 
# The calling user's scheduled email delivery of this report; empty when none is 
# set. Set it with `setScheduleReport` and remove it with `removeScheduleReport`.
schedule: ReportScheduleEntity 
# True when the current user has marked this report as a favorite (see 
# ClientFavorite).
isFavorite: Boolean! 
# Sales units granted shared access to this report (custom share mode).
# 
# Arguments
# filter: Filter SalesUnit relations by target SalesUnit 
# attributes.
# filterEdge: Filter ReportSharingSalesUnitRelation relations by 
# edge (relation) ReportSharingSalesUnitRelation attributes.
# orderBy: Order SalesUnit relations by target SalesUnit 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingUnits(
filter: SalesUnitFilterInput,
filterEdge: ReportSharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ReportSharingSalesUnitRelationEntityConnection 
# Users granted shared access to this report (custom share mode).
# 
# Arguments
# filter: Filter Client relations by target Client attributes.
# filterEdge: Filter ReportSharingClientRelation relations by 
# edge (relation) ReportSharingClientRelation attributes.
# orderBy: Order Client relations by target Client attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingClients(
filter: ClientFilterInput,
filterEdge: ReportSharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ReportSharingClientRelationEntityConnection 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
}
ReportEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
