> ## Documentation Index > Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt > Use this file to discover all available pages before exploring further. # ListReportsWithCumulativeSummary > List reports with cumulative summary. ## OpenAPI ````yaml /openapi.json get /api/v1/reports:with-cumulative-summary openapi: 3.0.0 info: title: Sift API version: '1.0' servers: - url: https://api.siftstack.com description: Production - url: https://gov.api.siftstack.com description: Gov security: - BearerAuth: [] tags: - name: TagService description: Service to programmatically interact with [tags](/glossary#tag). - name: CampaignService - name: ProtobufDescriptorService description: >- Service to programmatically interact with protobuf descriptors used for protobuf ingestion. externalDocs: description: Read more about what protobuf ingestion. url: /ingestion/protobuf_ingestion - name: AnnotationLogService description: >- Service to programmatically interact with [annotation logs](/glossary#annotation). externalDocs: description: Read more about annotations. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265486685 - name: MetadataService - name: DlqErrorsService - name: RuleService description: Service to programmatically interact with rules. externalDocs: description: Read more about what rules are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421102 - name: WebhookService - name: UserDefinedFunctionService - name: ReportTemplateService - name: RemoteFileService - name: PingService - name: FamilyService description: Service to programmatically interact with family configurations. - name: ExternalSyncService - name: ReportService - name: NotificationService description: Service to programmatically interact with in-app notifications. - name: ChannelSchemaService description: Service to programmatically interact with channel schemas - name: IngestService - name: UserService description: Service to programmatically interact with user objects. - name: TestReportService description: Service to manage test reports - name: PrincipalAttributeService description: Service to manage ABAC principal attributes. - name: ChannelService description: Service to programmatically interact with [channels](/glossary#channel). externalDocs: description: Read more about what channels are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265453943 - name: DataImportService - name: ExportService - name: PolicyService description: Service to manage ABAC policies. - name: ApiKeyService - name: CommentService description: >- Service to programmatically interact with comments attached to resources in the platform. - name: JobService - name: UserGroupService - name: ResourceAttributeService description: Service to manage ABAC resource attributes (entity attributes). - name: AutomationService - name: ViewService description: Service to programmatically interact with views. externalDocs: description: Read more about what views are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/298188809 - name: UnitService - name: DocsService - name: RoleService - name: SavedSearchService - name: RuleEvaluationService description: Service to evaluate rules. externalDocs: description: Read more about what rules are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421102 - name: RunService description: Service to programmatically interact with [runs](/glossary#run). externalDocs: description: Read more about what runs are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265454053 - name: PanelConfigurationService description: Service to programmatically interact with panel configurations. - name: IngestionConfigService description: >- Service to programmatically interact with [ingestion configs](/glossary#ingestion-config). externalDocs: description: Read more about what ingestion configs are. url: /ingestion/creating-amend-ingestion-config - name: CalculatedChannelService - name: CalculatedChannelsService description: Service to programmatically interact with calculated channels. externalDocs: description: Read more about calculated channels. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421153 - name: AnnotationService description: Service to programmatically interact with annotations. externalDocs: description: Read more about annotations. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265486685 - name: DataService description: Service to query data - name: MeService - name: AssetService description: Service to programmatically interact with [assets](/glossary#asset). externalDocs: description: Read more about what assets are. url: /data-model paths: /api/v1/reports:with-cumulative-summary: get: tags: - ReportService summary: ListReportsWithCumulativeSummary description: List reports with cumulative summary. operationId: ReportService_ListReportsWithCumulativeSummary parameters: - name: pageSize description: >- The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 50 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. in: query required: false schema: type: integer format: int64 - name: pageToken description: >- A page token, received from a previous `ListReportsWithCumulativeSummary` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReportsWithCumulativeSummary` must match the call that provided the page token. Optional. in: query required: false schema: type: string - name: filter description: >- A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `report_id`, `report_template_id`, `tag_name`, `name`, `run_id`, `report_type`, `is_archived`, `archived_date`, `created_date`, `created_by_user_id`, `metadata`, `modified_date`, and `modified_by_user_id`. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). in: query required: false schema: type: string - name: organizationId description: >- This field is only required if your user belongs to multiple organizations. in: query required: false schema: type: string - name: orderBy description: >- How to order the retrieved reports. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are `name`, `created_date` and `modified_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read [this](https://google.aip.dev/132#ordering) Example: "created_date desc,modified_date" in: query required: false schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: >- #/components/schemas/v1ListReportsWithCumulativeSummaryResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/rpcStatus' components: schemas: v1ListReportsWithCumulativeSummaryResponse: type: object properties: reports: type: array items: $ref: '#/components/schemas/v1ReportWithCumulativeSummary' nextPageToken: type: string description: >- The response of a call to `ReportService_ListReportsWithCumulativeSummaryResponse`. rpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' v1ReportWithCumulativeSummary: type: object properties: reportId: type: string description: The unique identifier of the report. reportTemplateId: type: string description: >- The identifier of the report template this report was created from, if any. runId: type: string description: The identifier of the run associated with this report. organizationId: type: string description: The organization this report belongs to. name: type: string description: The display name of the report. description: type: string description: An optional description of the report. createdByUserId: type: string description: The identifier of the user who created the report. modifiedByUserId: type: string description: The identifier of the user who last modified the report. createdDate: type: string format: date-time description: When the report was created. modifiedDate: type: string format: date-time description: When the report was last modified. cumulativeSummary: $ref: '#/components/schemas/v1ReportCumulativeRuleSummary' tags: type: array items: $ref: '#/components/schemas/v1ReportTag' description: Tags associated with this report. rerunFromReportId: type: string description: The identifier of the report this report was rerun from, if any. jobId: type: string description: The identifier of the job that produced this report, if any. archivedDate: type: string format: date-time description: When the report was archived, if it has been archived. isArchived: type: boolean description: Whether the report has been archived. reportType: $ref: '#/components/schemas/v1ReportType' canvasExecutionId: type: string description: >- For CANVAS reports, the id of the published canvas_execution this report row is linked to (read-through from canvas_executions.canvas_execution_id). Empty for RULE_EVALUATION reports. Used by clients to route to the canvas detail page. canvasStatus: $ref: '#/components/schemas/v1CanvasCellExecutionStatus' description: >- ReportWithCumulativeSummary is a projection of `Report` that replaces the per-rule `summaries` list with a single `cumulative_summary` aggregated across all rules. It is returned by `ListReportsWithCumulativeSummary` to keep response sizes manageable when listing many reports. required: - reportId - runId - organizationId - name - createdByUserId - modifiedByUserId - createdDate - modifiedDate - cumulativeSummary - tags - reportType protobufAny: type: object properties: '@type': type: string description: >- A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. additionalProperties: {} description: >- `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } v1ReportCumulativeRuleSummary: type: object properties: numAnnotationsOpen: type: integer format: int64 description: Total number of open (unresolved) annotations across all rules. numAnnotationsFailed: type: integer format: int64 description: Total number of failed (flagged) annotations across all rules. numAnnotationsPassed: type: integer format: int64 description: Total number of passed (resolved) annotations across all rules. numAnnotationsTotal: type: integer format: int64 description: >- Total number of annotations across all rules (open + failed + passed). numRulesCreated: type: integer format: int64 description: Number of rule versions in CREATED status. numRulesLive: type: integer format: int64 description: Number of rule versions currently running (LIVE status). numRulesFinished: type: integer format: int64 description: Number of rule versions that finished successfully. numRulesFailed: type: integer format: int64 description: Number of rule versions that failed during execution. numRulesCanceled: type: integer format: int64 description: Number of rule versions that were canceled. numRulesError: type: integer format: int64 description: Number of rule versions that encountered an error. numRulesTotal: type: integer format: int64 description: Total number of rule versions across all statuses. numOfRulesWithoutAnnotations: type: integer format: int64 description: Number of finished rule versions that produced no annotations. description: >- Aggregated annotation and rule-status counts across all rules in a report. Annotation counts (num_annotations_*) reflect the total number of annotations in each state summed over every rule version in the report. Rule counts (num_rules_*) reflect how many rule versions are in each execution status. required: - numAnnotationsOpen - numAnnotationsFailed - numAnnotationsPassed - numAnnotationsTotal - numRulesCreated - numRulesLive - numRulesFinished - numRulesFailed - numRulesCanceled - numRulesError - numRulesTotal - numOfRulesWithoutAnnotations v1ReportTag: type: object properties: tagName: type: string required: - tagName v1ReportType: type: string enum: - REPORT_TYPE_UNSPECIFIED - REPORT_TYPE_RULE_EVALUATION - REPORT_TYPE_CANVAS default: REPORT_TYPE_UNSPECIFIED description: >- ReportType discriminates the two kinds of report rows that share the unified `reports` surface. Rule-evaluation reports are tied to a run; canvas reports are tied to a published canvas_execution. v1CanvasCellExecutionStatus: type: string enum: - CANVAS_CELL_EXECUTION_STATUS_UNSPECIFIED - CANVAS_CELL_EXECUTION_STATUS_IN_PROGRESS - CANVAS_CELL_EXECUTION_STATUS_AUTO_PASSED - CANVAS_CELL_EXECUTION_STATUS_AUTO_FAILED - CANVAS_CELL_EXECUTION_STATUS_MANUAL_PASSED - CANVAS_CELL_EXECUTION_STATUS_MANUAL_FAILED - CANVAS_CELL_EXECUTION_STATUS_ERROR - CANVAS_CELL_EXECUTION_STATUS_SKIPPED - CANVAS_CELL_EXECUTION_STATUS_OPEN - CANVAS_CELL_EXECUTION_STATUS_MANUALLY_CANCELLED default: CANVAS_CELL_EXECUTION_STATUS_UNSPECIFIED description: >- Status of a single canvas cell execution. Also used as the status of the parent CanvasExecution: the parent rolls up its cells' statuses into a single value (e.g. any AUTO_FAILED cell yields an AUTO_FAILED execution). securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````