picked 0.0.101-next.2 → 0.0.101

package/docs/reference/management-api/schema/report.md

@@ -0,0 +1,243 @@
+---
+type: reference
+layout: docs
+generated: true
+---
+
+# Report schema
+
+The operations and types that `report.graphql` adds to the Management API. See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
+
+## Queries
+
+### `report`
+
+Fetch a single report by id. Requires authentication.
+
+```graphql
+report(id: ID!): ProjectReport @auth
+```
+
+## Mutations
+
+### `reportCreate`
+
+Create a new report. Requires scope: `ORGANIZATION_REPORTS_CREATE`.
+
+```graphql
+reportCreate(input: ReportCreateInput!): ReportCreatePayload! @auth
+```
+
+### `reportUpdate`
+
+Update a report. Requires scope: `ORGANIZATION_REPORTS_UPDATE`.
+
+```graphql
+reportUpdate(input: ReportUpdateInput!): ReportUpdatePayload! @auth
+```
+
+### `reportDelete`
+
+Delete a report. Requires scope: `ORGANIZATION_REPORTS_DELETE`.
+
+```graphql
+reportDelete(input: ReportDeleteInput!): ReportDeletePayload! @auth
+```
+
+## Types
+
+### `ReportSortKeys`
+
+```graphql
+"""
+Sort keys accepted by `Project.reports(...)`. Pair with `reverse: true` to flip the order.
+"""
+enum ReportSortKeys {
+  """Sort by report `name` (alphabetical)."""
+  NAME
+  """Sort by display order (the manual order the user assigned)."""
+  DISPLAY_ORDER
+  """Sort by `createdAt`."""
+  CREATED_AT
+}
+```
+
+### `ReportType`
+
+```graphql
+"""Type of report (one chart vs. a dashboard of charts)."""
+enum ReportType {
+  """A single question / chart report."""
+  QUESTION
+  """A multi-chart dashboard report."""
+  DASHBOARD
+}
+```
+
+### `Report`
+
+```graphql
+"""
+Picked-side report definition — a pointer to a Metabase report
+(question or dashboard) plus the display-only metadata (name,
+description).
+"""
+type Report {
+  """Unique identifier for the report."""
+  id: ID!
+  """Metabase report id."""
+  metabaseReportId: Int!
+  """Display name of the report."""
+  name: String!
+  """Description of the report."""
+  description: String
+  """Type of the Metabase report."""
+  metabaseReportType: ReportType!
+  """When this report was created."""
+  createdAt: DateTime!
+  """When this report was last updated."""
+  updatedAt: DateTime!
+}
+```
+
+### `ProjectReport`
+
+```graphql
+"""
+A report assigned to a project with embed configuration. The
+`lockedParameters` blob is forwarded to Metabase when generating the
+embed URL — typically used to lock the report to the project's id.
+"""
+type ProjectReport {
+  """Unique identifier for the project report."""
+  id: ID!
+  """The underlying report definition."""
+  report: Report!
+  """Parameters locked for the embedded report (forwarded to Metabase)."""
+  lockedParameters: JSON
+  """Display order in the project's report list. Null orders last."""
+  displayOrder: Int
+  """When this project report was created."""
+  createdAt: DateTime!
+  """Email of the user who created this project report."""
+  createdBy: String
+  """Embeddable URL for the report — sign and time-limited."""
+  embedUrl: String!
+}
+```
+
+### `ProjectReportEdge`
+
+```graphql
+"""Edge type for `ProjectReportConnection`."""
+type ProjectReportEdge {
+  """Pagination cursor for this edge."""
+  cursor: String!
+  """The project report."""
+  node: ProjectReport!
+}
+```
+
+### `ProjectReportConnection`
+
+```graphql
+"""Relay-style connection of project reports."""
+type ProjectReportConnection {
+  """List of project-report edges."""
+  edges: [ProjectReportEdge!]!
+  """Pagination metadata."""
+  pageInfo: PageInfo!
+  """Total number of project reports."""
+  totalCount: Int!
+}
+```
+
+### `ReportCreateInput`
+
+```graphql
+"""Input for `reportCreate`."""
+input ReportCreateInput {
+  """ID of the project to add the report to."""
+  projectId: ID!
+  """ID of the organisation."""
+  organizationId: ID!
+  """Display name for the report."""
+  name: String!
+  """Description of the report."""
+  description: String
+  """Metabase report id to embed."""
+  metabaseReportId: Int!
+  """Type of the Metabase report."""
+  metabaseReportType: ReportType!
+  """Parameters to lock for the embedded report."""
+  lockedParameters: JSON
+  """Display order in the project's report list."""
+  displayOrder: Int
+}
+```
+
+### `ReportCreatePayload`
+
+```graphql
+"""Payload returned by `reportCreate`."""
+type ReportCreatePayload {
+  """The created project report."""
+  projectReport: ProjectReport
+}
+```
+
+### `ReportUpdateInput`
+
+```graphql
+"""
+Input for `reportUpdate`. Omit a field to leave it unchanged (except `metabaseReportType`, which is required).
+"""
+input ReportUpdateInput {
+  """ID of the project report to update."""
+  projectReportId: ID!
+  """New display name."""
+  name: String
+  """New description."""
+  description: String
+  """New Metabase report id."""
+  metabaseReportId: Int
+  """
+  Type of the Metabase report. Required to disambiguate `metabaseReportId`.
+  """
+  metabaseReportType: ReportType!
+  """New locked parameters."""
+  lockedParameters: JSON
+  """New display order."""
+  displayOrder: Int
+}
+```
+
+### `ReportUpdatePayload`
+
+```graphql
+"""Payload returned by `reportUpdate`."""
+type ReportUpdatePayload {
+  """The updated project report."""
+  projectReport: ProjectReport
+}
+```
+
+### `ReportDeleteInput`
+
+```graphql
+"""Input for `reportDelete`."""
+input ReportDeleteInput {
+  """ID of the project report to delete."""
+  projectReportId: ID!
+}
+```
+
+### `ReportDeletePayload`
+
+```graphql
+"""Payload returned by `reportDelete`."""
+type ReportDeletePayload {
+  """Whether the report was deleted successfully."""
+  success: Boolean!
+}
+```

package/docs/reference/management-api/schema/saved-view.md

@@ -0,0 +1,288 @@
+---
+type: reference
+layout: docs
+generated: true
+---
+
+# Saved view schema
+
+The operations and types that `saved-view.graphql` adds to the Management API. See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
+
+## Queries
+
+### `savedView`
+
+Get a saved view by ID. Requires scope: `ORGANIZATION_PROJECTS_READ`.
+
+```graphql
+savedView(input: SavedViewInput!): SavedView @auth
+```
+
+## Mutations
+
+### `savedViewCreate`
+
+Save a view of a project's list. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`.
+
+```graphql
+savedViewCreate(input: SavedViewCreateInput!): SavedViewCreatePayload! @auth
+```
+
+### `savedViewUpdate`
+
+Rename a saved view, change what it restores, or move the default. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`.
+
+```graphql
+savedViewUpdate(input: SavedViewUpdateInput!): SavedViewUpdatePayload! @auth
+```
+
+### `savedViewDelete`
+
+Delete a saved view. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`.
+
+```graphql
+savedViewDelete(input: SavedViewDeleteInput!): SavedViewDeletePayload! @auth
+```
+
+## Types
+
+### `SavedView`
+
+```graphql
+"""A named set of list controls, restoring what a list page looked like."""
+type SavedView {
+  """Unique saved view identifier."""
+  id: ID!
+  """ID of the project this view belongs to."""
+  projectId: ID!
+  """Which list this view applies to."""
+  resource: SavedViewResource!
+  """What the viewer called it."""
+  name: String!
+  """
+  The `q` query-string value: the list's own search language, uninterpreted.
+  """
+  query: String
+  """
+  The `cols` query-string value: comma-separated column paths, in display order.
+  """
+  columnPaths: String
+  """The `sort` query-string value, as `<key>:<direction>`."""
+  sort: String
+  """
+  The `from` query-string value: the first day of a fixed capture window, as `YYYY-MM-DD`.
+  """
+  windowFrom: String
+  """
+  The `to` query-string value: the last day of a fixed capture window, as `YYYY-MM-DD`.
+  """
+  windowTo: String
+  """
+  The `last` query-string value: how many units a relative capture window spans.
+  """
+  windowLast: String
+  """
+  The `unit` query-string value: the unit a relative capture window counts in.
+  """
+  windowUnit: String
+  """The `chart` query-string value: how the chart above the list is drawn."""
+  chart: String
+  """
+  The `interval` query-string value: the bucket width of the chart above the list.
+  """
+  chartInterval: String
+  """
+  The `chartBy` query-string value: the path the chart above the list splits its series by.
+  """
+  chartBy: String
+  """
+  The `compare` query-string value: `previous` when the chart above the list outlines the period before its window.
+  """
+  chartCompare: String
+  """
+  Whether entering the list with nothing in its URL opens this view. At most one per project and resource.
+  """
+  isDefault: Boolean!
+  """When this view was saved."""
+  createdAt: DateTime!
+  """When this view was last changed."""
+  updatedAt: DateTime!
+}
+```
+
+### `SavedViewResource`
+
+```graphql
+"""The list a saved view applies to."""
+enum SavedViewResource {
+  """The project's captured leads."""
+  LEADS
+  """The project's visitor sessions, read from its analytics warehouse."""
+  SESSIONS
+}
+```
+
+### `SavedViewConnection`
+
+```graphql
+"""Relay-style connection of saved views."""
+type SavedViewConnection {
+  """List of saved view edges."""
+  edges: [SavedViewEdge!]!
+  """
+  Flat list of saved views, equivalent to `edges[].node`. Convenience accessor.
+  """
+  nodes: [SavedView!]!
+  """Pagination metadata."""
+  pageInfo: PageInfo!
+  """Total number of saved views matching the query."""
+  totalCount: Int!
+}
+```
+
+### `SavedViewEdge`
+
+```graphql
+"""Edge type for `SavedViewConnection`."""
+type SavedViewEdge {
+  """Pagination cursor for this edge."""
+  cursor: String!
+  """The saved view."""
+  node: SavedView!
+}
+```
+
+### `SavedViewInput`
+
+```graphql
+"""Input for the top-level `savedView` query."""
+input SavedViewInput {
+  """ID of the saved view to fetch."""
+  id: ID!
+}
+```
+
+### `SavedViewCreateInput`
+
+```graphql
+"""Input for `savedViewCreate`."""
+input SavedViewCreateInput {
+  """ID of the project the view belongs to."""
+  projectId: ID!
+  """Which list this view applies to."""
+  resource: SavedViewResource!
+  """What to call it. One to 120 characters once trimmed."""
+  name: String!
+  """The `q` query-string value."""
+  query: String
+  """The `cols` query-string value."""
+  columnPaths: String
+  """The `sort` query-string value."""
+  sort: String
+  """The `from` query-string value."""
+  windowFrom: String
+  """The `to` query-string value."""
+  windowTo: String
+  """The `last` query-string value."""
+  windowLast: String
+  """The `unit` query-string value."""
+  windowUnit: String
+  """The `chart` query-string value."""
+  chart: String
+  """The `interval` query-string value."""
+  chartInterval: String
+  """The `chartBy` query-string value."""
+  chartBy: String
+  """The `compare` query-string value."""
+  chartCompare: String
+  """
+  Make this the view the list opens with. Takes the default from whichever view held it.
+  """
+  isDefault: Boolean
+}
+```
+
+### `SavedViewUpdateInput`
+
+```graphql
+"""
+Input for `savedViewUpdate`. An omitted field is left as it is, so renaming a
+view does not disturb the URL it restores.
+"""
+input SavedViewUpdateInput {
+  """ID of the saved view to update."""
+  id: ID!
+  """A new name."""
+  name: String
+  """A new `q` query-string value."""
+  query: String
+  """A new `cols` query-string value."""
+  columnPaths: String
+  """A new `sort` query-string value."""
+  sort: String
+  """A new `from` query-string value."""
+  windowFrom: String
+  """A new `to` query-string value."""
+  windowTo: String
+  """A new `last` query-string value."""
+  windowLast: String
+  """A new `unit` query-string value."""
+  windowUnit: String
+  """A new `chart` query-string value."""
+  chart: String
+  """A new `interval` query-string value."""
+  chartInterval: String
+  """A new `chartBy` query-string value."""
+  chartBy: String
+  """A new `compare` query-string value."""
+  chartCompare: String
+  """Take or give up the default."""
+  isDefault: Boolean
+}
+```
+
+### `SavedViewDeleteInput`
+
+```graphql
+"""Input for `savedViewDelete`."""
+input SavedViewDeleteInput {
+  """ID of the saved view to delete."""
+  id: ID!
+}
+```
+
+### `SavedViewCreatePayload`
+
+```graphql
+"""Payload returned by `savedViewCreate`."""
+type SavedViewCreatePayload {
+  """The saved view, or null when `userErrors` is non-empty."""
+  savedView: SavedView
+  """Validation failures, keyed by input field."""
+  userErrors: [UserError!]!
+}
+```
+
+### `SavedViewUpdatePayload`
+
+```graphql
+"""Payload returned by `savedViewUpdate`."""
+type SavedViewUpdatePayload {
+  """The updated saved view, or null when `userErrors` is non-empty."""
+  savedView: SavedView
+  """Validation failures, keyed by input field."""
+  userErrors: [UserError!]!
+}
+```
+
+### `SavedViewDeletePayload`
+
+```graphql
+"""Payload returned by `savedViewDelete`."""
+type SavedViewDeletePayload {
+  """ID of the deleted saved view."""
+  deletedSavedViewId: ID
+  """Validation failures, keyed by input field."""
+  userErrors: [UserError!]!
+}
+```