> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sublay.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Reports
> File content reports against entities and comments, and read the moderation queue
export const SpaceReputationParams = ({variant = "context", field = "path"}) => {
const isUser = variant === "user";
return <>
Opt-in. Adds a spaceReputation number to each returned user,
scoped to a single space. Requires the reputation bundle.
The reputation total is always present regardless;{" "}
spaceReputation is purely additive and only appears when you
pass this object. This object is the primary form — it
replaces the deprecated flat props below. See the{" "}
Reputation data model for the
full contract.
{isUser ?
Which bucket to read. A space <uuid> reads that
space's bucket; "none" reads the
project-general (space-less) bucket.{" "}
"context" is rejected (400) on this
endpoint — there is no space context to derive. The empty string
and the legacy general / null aliases are
also rejected. Missing buckets read as 0.
:
Which bucket to read. One of: a space <uuid>{" "}
(that space's bucket), "none" (the
project-general, space-less bucket), or{" "}
"context" (the space derived from the
request context — resolved per-row on lists, or the single space on
member/team/conversation surfaces). The empty string and the legacy{" "}
general / null aliases are rejected (400).
Missing buckets read as 0.
}
Only honored when spaceId is an explicit space <uuid>.
When true, spaceReputation is the{" "}
subtree sum — the named space plus all of its
descendant spaces (the root space's own bucket included). Ignored for{" "}
"none"; not allowed with "context".
{isUser ?
Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid> or "none" only —{" "}
"context" is rejected (400) on this endpoint.
:
Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid>, "none", or{" "}
"context".
}
Deprecated — use{" "}
spaceReputation.includeDescendants instead. The flat form,
only honored alongside an explicit spaceReputationId <uuid>.
;
};
The `reports` module lets end users file reports against entities and comments, and lets moderators read the moderated reports queue.
***
### createReport
Files a report against an entity, comment, or chat message. Repeat reports of the same target are deduplicated.
```typescript theme={null}
const { message, code } = await sublay.reports.createReport({
targetType: "comment",
targetId: "cmt_abc123",
reason: "spam",
details: "Posting the same link repeatedly.",
});
```
The kind of content being reported.
The ID of the entity, comment, or chat message being reported.
One of `spam`, `inappropriateContent`, `harassment`, `misinformation`,
`hateSpeech`, `violence`, `illegalActivity`, `selfHarm`, `other`. The API
rejects anything else — use `other` plus `details` for the rest.
Additional context about the report.
Reporting a chat message uses `targetType: "message"` with the **message id**
as `targetId` — the conversation is resolved server-side. Reports on space
conversations reach space moderators; reports on DMs and group chats are
project-level and appear only in the Sublay dashboard.
**Returns** — `Promise<{ message: string; code: "report/created" | "report/updated" | "report/already-reported" }>`
***
### fetchModeratedReports
Fetches a paginated list of moderated reports, with optional filters.
```typescript theme={null}
const { data, pagination } = await sublay.reports.fetchModeratedReports({
status: "pending",
sortBy: "new",
page: 1,
limit: 20,
});
```
Restrict results to reports within a specific space.
Restrict results to reports of a specific target type. Message reports appear
in this queue only for space conversations — DM and group reports are
project-level and surface in the dashboard.
Restrict results to reports with a specific moderation status.
Sort order for the returned reports.
The page of results to fetch.
The number of reports to return per page.
**Returns** — `Promise>`
Each `Report` carries `id`, `spaceId`, `targetId`, `targetType`, `status`, `reporterCount`, timestamps, and optional `userReports`, `target`, and `space` associations.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.