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

# Location metrics



## OpenAPI

````yaml get /location-metrics
openapi: 3.0.0
info:
  title: Naismith Analytics API
  description: The N3 API
  version: '0.1'
  contact: {}
servers: []
security: []
tags: []
paths:
  /location-metrics:
    get:
      tags:
        - Data
      summary: Create a location metrics report
      operationId: location-metrics
      parameters:
        - name: postcode
          required: true
          in: query
          example: AB1 2CD
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LocationMetricsDto'
components:
  schemas:
    LocationMetricsDto:
      type: object
      properties:
        average_value:
          type: number
          description: Average value of projects (£)
          example: 100000
        average_risk:
          type: number
          description: Average risk score of projects
          example: 45
        average_project_length_days:
          type: number
          description: Average length of projects in days
          example: 564
        average_programme_drift_days:
          type: number
          description: Average drift of projects (days over/under target date)
          example: 54
        _meta:
          $ref: '#/components/schemas/LocationMetricsMetaDto'
      required:
        - average_value
        - average_risk
        - average_project_length_days
        - average_programme_drift_days
        - _meta
    LocationMetricsMetaDto:
      type: object
      properties:
        latitude:
          type: number
          description: Latitude of the location
          example: 51.507351
        longitude:
          type: number
          description: Longitude of the location
          example: -0.127647
        created_at:
          type: string
      required:
        - latitude
        - longitude
        - created_at

````