> ## Documentation Index
> Fetch the complete documentation index at: https://api-doc.track.graviton.ma/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a report definition

> Works with resources accessible to your account. Subaccounts need the `reports` permission. Requires write access. A read-only account cannot perform this operation.



## OpenAPI

````yaml /openapi.json post /reports
openapi: 3.0.3
info:
  title: Graviton Geo V1 Client API
  version: 2.0.0
  description: >-
    Client API for Graviton Geo V1. Use an API token to access your fleet,
    tracking, resources, commands, and reports. The REST API base path is
    /api/v2.
servers:
  - url: https://fleet.graviton.ma/api/v2
    description: Production
security:
  - ApiKey: []
tags:
  - name: System
  - name: Account
  - name: Fleet
  - name: Tracking
  - name: Commands
  - name: Places
  - name: People and groups
  - name: Events
  - name: Maintenance
  - name: Sensors
  - name: Reports
  - name: Templates
paths:
  /reports:
    post:
      tags:
        - Reports
      summary: Create a report definition
      description: >-
        Works with resources accessible to your account. Subaccounts need the
        `reports` permission. Requires write access. A read-only account cannot
        perform this operation.
      operationId: post_reports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportsInput'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      report_id:
                        oneOf:
                          - type: number
                          - type: string
                        description: >-
                          Numeric value; legacy values may be serialized as
                          strings.
                      name:
                        description: Name.
                      type:
                        description: Type.
                      format:
                        description: Format.
                      show_addresses:
                        description: Show addresses.
                      zones_addresses:
                        description: Zones addresses.
                      show_trip_image:
                        description: Show trip image.
                      stop_duration:
                        description: Stop duration.
                      speed_limit:
                        description: Speed limit.
                      imei:
                        description: Imei.
                      zone_ids:
                        description: Zone ids.
                      sensor_names:
                        description: Sensor names.
                      data_items:
                        description: Data items.
                      schedule_period:
                        description: Schedule period.
                      schedule_email_address:
                        description: Schedule email address.
                      dt_schedule_d:
                        description: Dt schedule d.
                      dt_schedule_w:
                        description: Dt schedule w.
                    additionalProperties: true
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/WritesDisabled'
components:
  schemas:
    ReportsInput:
      type: object
      required:
        - name
        - type
        - format
      properties:
        name:
          description: Name.
        type:
          description: Type.
        format:
          description: Format.
        show_addresses:
          description: Show addresses.
        zones_addresses:
          description: Zones addresses.
        show_trip_image:
          description: Show trip image.
        stop_duration:
          description: Stop duration.
        speed_limit:
          description: Speed limit.
        imei:
          description: Imei.
        zone_ids:
          description: Zone ids.
        sensor_names:
          description: Sensor names.
        data_items:
          description: Data items.
        schedule_period:
          description: Schedule period.
        schedule_email_address:
          description: Schedule email address.
        dt_schedule_d:
          description: Dt schedule d.
        dt_schedule_w:
          description: Dt schedule w.
    Meta:
      type: object
      properties:
        request_id:
          type: string
        page:
          type: integer
        per_page:
          type: integer
        total:
          type: integer
        pages:
          type: integer
    ErrorEnvelope:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/Meta'
  responses:
    Error:
      description: API error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    WritesDisabled:
      description: Production write safety switch is disabled
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Your Graviton API token. Send Authorization: Bearer YOUR_API_TOKEN or
        Authorization: YOUR_API_TOKEN. Each token has individual permissions; a
        valid token without the permission required by the method and route
        returns 403 TOKEN_PERMISSION_DENIED.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.