> ## Documentation Index
> Fetch the complete documentation index at: https://docs.terraspect.earth/llms.txt
> Use this file to discover all available pages before exploring further.

# Impact metrics

> Get metrics of impact data related to a project



## OpenAPI

````yaml get /impact/metrics/{project_id}
openapi: 3.0.0
info:
  title: Terraspect API
  version: 0.0.2
servers:
  - url: https://api.terraspect.earth
    description: Production server
security: []
tags:
  - name: Projects
    description: Endpoints for retrieving project and developer information
  - name: Impact
    description: Endpoints for accessing impact and community metrics
  - name: Financials
    description: Endpoints for accessing financial data (some require extended permissions)
paths:
  /impact/metrics/{project_id}:
    get:
      summary: Get Impact Metrics
      description: Retrieves impact metrics for a specific project
      operationId: getImpactMetrics
      parameters:
        - name: project_id
          in: path
          required: true
          description: Unique identifier of the project
          schema:
            type: string
      responses:
        '200':
          description: Impact metrics successfully retrieved
          content:
            application/json:
              schema:
                type: object
                required:
                  - project_id
                  - impact
                properties:
                  project_id:
                    type: string
                    example: proj_789012
                  impact:
                    type: array
                    items:
                      $ref: '#/components/schemas/ImpactMetric'
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                missing_token:
                  summary: No token provided
                  value:
                    code: MISSING_TOKEN
                    message: No bearer token provided
                expired_token:
                  summary: Token expired
                  value:
                    code: TOKEN_EXPIRED
                    message: Token has expired. Please obtain a new token.
                invalid_token:
                  summary: Invalid token
                  value:
                    code: INVALID_TOKEN
                    message: Token is malformed or signature is invalid
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ExtendedAuth: []
components:
  schemas:
    ImpactMetric:
      type: object
      required:
        - sdg_tag
        - title
        - outcome_metric
      properties:
        sdg_tag:
          type: string
          description: Sustainable Development Goal identifier
          example: SDG1.1 No poverty
        title:
          type: string
          description: Human-readable title of the impact metric
          example: Average income per household derived from project activity
        outcome_metric:
          type: number
          description: Measured outcome
          example: 5500
        impact_target:
          type: number
          nullable: true
          description: Target value for the impact metric
          example: 10000
        impact_progress:
          type: number
          nullable: true
          description: Current progress towards the target in percent
          example: 55
        methodology:
          type: string
          nullable: true
          description: Description of measurement methodology
          example: >-
            Terraspect calculation based on verified project developer payments
            data
        explanation:
          type: string
          nullable: true
          description: Detailed explanation of the impact metric
          example: >-
            Total amount paid to participants of the project divided by total
            number of participants
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error code for machine processing
          example: INVALID_PROJECT_ID
        message:
          type: string
          description: Human-readable error message
          example: The provided project ID does not exist
        details:
          type: object
          description: Additional error details when available
          nullable: true
  securitySchemes:
    ExtendedAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Extended access token required for more sensitive data, in the format
        `Authorization: Bearer <token>`

````