> ## 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. # CreateReportTemplate > Create a report template. ## OpenAPI ````yaml /openapi.json post /api/v1/report-templates 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/report-templates: post: tags: - ReportTemplateService summary: CreateReportTemplate description: Create a report template. operationId: ReportTemplateService_CreateReportTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/v1CreateReportTemplateRequest' description: >- The request of a call to `ReportTemplateService_CreateReportTemplate` to create a report template. required: true responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1CreateReportTemplateResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/rpcStatus' components: schemas: v1CreateReportTemplateRequest: type: object properties: name: type: string clientKey: type: string description: type: string tagNames: type: array items: type: string organizationId: type: string title: >- `organization_id` is only required if your user belongs to multiple organizations ruleIds: $ref: '#/components/schemas/v1CreateReportTemplateRequestRuleIds' ruleClientKeys: $ref: '#/components/schemas/v1CreateReportTemplateRequestClientKeys' metadata: type: array items: $ref: '#/components/schemas/v1MetadataValue' description: >- The request of a call to `ReportTemplateService_CreateReportTemplate` to create a report template. required: - name - tagNames v1CreateReportTemplateResponse: type: object properties: reportTemplate: $ref: '#/components/schemas/v1ReportTemplate' description: >- The response of a call to `ReportTemplateService_CreateReportTemplate` to create a report template. required: - reportTemplate rpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' v1CreateReportTemplateRequestRuleIds: type: object properties: ruleIds: type: array items: type: string description: >- Initial rule order on the new template: first `rule_id` is `display_order` 0, second is 1, etc. required: - ruleIds v1CreateReportTemplateRequestClientKeys: type: object properties: ruleClientKeys: type: array items: type: string description: >- Initial template rule order follows server resolution of keys to rules (not client-defined per-key ordering). required: - ruleClientKeys v1MetadataValue: type: object properties: key: $ref: '#/components/schemas/v1MetadataKey' stringValue: type: string numberValue: type: number format: double booleanValue: type: boolean relationValue: $ref: '#/components/schemas/v1MetadataRelationValue' archivedDate: type: string format: date-time isArchived: type: boolean description: >- Whether the metadata value is archived. This is inferred from whether archived_date is set. required: - key v1ReportTemplate: type: object properties: reportTemplateId: type: string organizationId: type: string clientKey: type: string name: type: string description: type: string archivedDate: type: string format: date-time createdByUserId: type: string modifiedByUserId: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time rules: type: array items: $ref: '#/components/schemas/v1ReportTemplateRule' description: >- Rules on this template. On responses, sort by each rule's `display_order` ascending for execution order. On writes, if `display_order` is omitted on a rule, that rule's position follows the slice order of `rules` (same as explicit orders 0..n-1). tags: type: array items: $ref: '#/components/schemas/v1ReportTemplateTag' metadata: type: array items: $ref: '#/components/schemas/v1MetadataValue' isArchived: type: boolean description: >- Whether the report template is archived. This is inferred from whether archived_date is set. required: - reportTemplateId - organizationId - name - createdByUserId - modifiedByUserId - createdDate - modifiedDate - rules - tags - metadata - isArchived 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" } v1MetadataKey: type: object properties: name: type: string type: $ref: '#/components/schemas/v1MetadataKeyType' archivedDate: type: string format: date-time isArchived: type: boolean description: >- Whether the metadata key is archived. This is inferred from whether archived_date is set. The filter field type this key maps to, so a client can build a CEL filter against it (`metadata[""]`) and resolve its operators and functions from FilterGrammarService. Derived from `type`. required: - name - type v1MetadataRelationValue: type: object properties: resourceType: type: string resourceId: type: string required: - resourceType - resourceId v1ReportTemplateRule: type: object properties: ruleId: type: string ruleVersionId: type: string ruleVersionNumber: type: integer format: int64 clientKey: type: string displayOrder: type: integer format: int64 description: >- Zero-based order for this rule on the template. Copied to `ReportRuleSummary.display_order` when creating a report from the template. Lower values indicate earlier position in the template and on generated reports. Optional on writes (e.g. `UpdateReportTemplate`): if omitted, servers use the order of entries in `ReportTemplate.rules` (first entry is earliest). On reads, this field is always populated. required: - ruleId - ruleVersionId - ruleVersionNumber v1ReportTemplateTag: type: object properties: tagName: type: string required: - tagName v1MetadataKeyType: type: string enum: - METADATA_KEY_TYPE_UNSPECIFIED - METADATA_KEY_TYPE_STRING - METADATA_KEY_TYPE_NUMBER - METADATA_KEY_TYPE_BOOLEAN - METADATA_KEY_TYPE_RELATION default: METADATA_KEY_TYPE_UNSPECIFIED description: |- Metadata key type. - METADATA_KEY_TYPE_STRING: string - METADATA_KEY_TYPE_NUMBER: number - METADATA_KEY_TYPE_BOOLEAN: boolean - METADATA_KEY_TYPE_RELATION: relation — references another resource by UUID (e.g. folder membership) securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````