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

# Get network endpoint summary

> Returns who a network endpoint is and what it did over the range: its resolved name, kind, provider, service, region, vendor, AS number, private scope and address, the inventory resources it maps to, when traffic was first and last seen, and its totals as a client and as a server. Totals count each connection once from this endpoint's side: bytes_sent and bytes_received are from the endpoint's own point of view, unhealthy_connections is reset plus refused plus failed, and failure_rate is unhealthy over opened connections capped at 1. cost is the period cost (bytes in the range priced at each connection's attributed rate) and cost_monthly is the monthly projection of the connections that carried traffic; both are null when no connection is priced. cross_zone_share and cross_region_share are the shares of bytes by locality, and cost_split divides cost_monthly into internet, cross zone and other. An endpoint that was merged into another resolves to the surviving endpoint, whose id is returned in identity.id. An endpoint with no traffic in the range returns zero totals



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/service-map/endpoints/{id}/summary
openapi: 3.0.0
info:
  description: Read and manage your CostGraph organization, spend, alerts, and settings.
  title: CostGraph API
  contact: {}
  version: '1.0'
servers:
  - url: https://api.costgraph.ai
security: []
tags:
  - name: ai
    x-group: AI
  - name: ai-serving
    x-group: AI serving
  - name: anomalies
    x-group: Anomalies
  - name: auth
    x-group: Auth
  - name: billing
    x-group: Billing
  - name: billing-export
    x-group: Billing export
  - name: budgets
    x-group: Budgets
  - name: ci
    x-group: CI
  - name: compute-recommendations
    x-group: Compute recommendations
  - name: config
    x-group: Config
  - name: context-graph
    x-group: Context graph
  - name: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - name: network-requests
    x-group: Network requests
  - name: notifications
    x-group: Notifications
  - name: oauth
    x-group: OAuth
  - name: oauth-clients
    x-group: OAuth clients
  - name: opencost
    x-group: OpenCost
  - name: organization
    x-group: Audit log
  - name: organizations
    x-group: Organizations
  - name: placement-alternatives
    x-group: Placement alternatives
  - name: reports
    x-group: Reports
  - name: service-map
    x-group: Service map
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - name: ticketing
    x-group: Ticketing
  - name: user
    x-group: Users
  - name: virtual-machines
    x-group: Virtual machines
  - name: virtual-tags
    x-group: Virtual tags
  - name: workflows
    x-group: Workflows
paths:
  /api/v1/tenant/service-map/endpoints/{id}/summary:
    get:
      tags:
        - service-map
      summary: Get network endpoint summary
      description: >-
        Returns who a network endpoint is and what it did over the range: its
        resolved name, kind, provider, service, region, vendor, AS number,
        private scope and address, the inventory resources it maps to, when
        traffic was first and last seen, and its totals as a client and as a
        server. Totals count each connection once from this endpoint's side:
        bytes_sent and bytes_received are from the endpoint's own point of view,
        unhealthy_connections is reset plus refused plus failed, and
        failure_rate is unhealthy over opened connections capped at 1. cost is
        the period cost (bytes in the range priced at each connection's
        attributed rate) and cost_monthly is the monthly projection of the
        connections that carried traffic; both are null when no connection is
        priced. cross_zone_share and cross_region_share are the shares of bytes
        by locality, and cost_split divides cost_monthly into internet, cross
        zone and other. An endpoint that was merged into another resolves to the
        surviving endpoint, whose id is returned in identity.id. An endpoint
        with no traffic in the range returns zero totals
      parameters:
        - description: Tenant ID
          name: X-CostGraph-Tenant-ID
          in: header
          required: true
          schema:
            type: string
        - description: Network endpoint ID
          name: id
          in: path
          required: true
          schema:
            type: string
        - description: Range start timestamp in RFC3339 format
          name: start
          in: query
          required: true
          schema:
            type: string
        - description: Range end timestamp in RFC3339 format
          name: end
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/responses.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/networkendpoint.Summary'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    responses.SuccessResponse:
      type: object
      required:
        - message
        - status
      properties:
        data: {}
        message:
          type: string
          example: some message
        status:
          type: string
          example: success
    networkendpoint.Summary:
      type: object
      properties:
        as_client:
          $ref: '#/components/schemas/networkendpoint.RoleTotals'
        as_server:
          $ref: '#/components/schemas/networkendpoint.RoleTotals'
        bytes_in:
          type: number
        bytes_out:
          type: number
        cost:
          type: number
          x-semantic: costAmount
          nullable: true
        cost_monthly:
          type: number
          x-semantic: costAmount
          nullable: true
        cost_split:
          $ref: '#/components/schemas/networkendpoint.CostSplit'
        cross_region_share:
          type: number
          nullable: true
        cross_zone_share:
          type: number
          nullable: true
        first_seen:
          type: string
          nullable: true
        identity:
          $ref: '#/components/schemas/networkendpoint.Identity'
        last_seen:
          type: string
          nullable: true
        range:
          $ref: '#/components/schemas/networkendpoint.Range'
        related:
          $ref: '#/components/schemas/networkendpoint.Related'
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    networkendpoint.RoleTotals:
      type: object
      properties:
        bytes_received:
          type: number
        bytes_sent:
          type: number
        connections_closed:
          type: integer
        connections_failed:
          type: integer
        connections_opened:
          type: integer
        connections_refused:
          type: integer
        connections_reset:
          type: integer
        cost:
          type: number
          x-semantic: costAmount
          nullable: true
        cost_monthly:
          type: number
          x-semantic: costAmount
          nullable: true
        failure_rate:
          type: number
          nullable: true
        peers:
          type: integer
        unhealthy_connections:
          type: integer
    networkendpoint.CostSplit:
      type: object
      properties:
        cross_zone_cost_monthly:
          type: number
          x-semantic: costAmount
          nullable: true
        internet_cost_monthly:
          type: number
          x-semantic: costAmount
          nullable: true
        other_cost_monthly:
          type: number
          x-semantic: costAmount
          nullable: true
    networkendpoint.Identity:
      type: object
      properties:
        address:
          type: string
        asn:
          type: string
        cluster:
          type: string
        endpoint_key:
          type: string
        engine:
          type: string
        id:
          type: string
        kind:
          type: string
        labels:
          type: object
          additionalProperties:
            type: string
        name:
          type: string
        namespace:
          type: string
        parent_kind:
          type: string
        parent_name:
          type: string
        provider:
          type: string
        region:
          type: string
        resolution_source:
          type: string
        scope:
          type: string
        service:
          type: string
        vendor:
          type: string
    networkendpoint.Range:
      type: object
      properties:
        end:
          type: string
        start:
          type: string
    networkendpoint.Related:
      type: object
      properties:
        cluster_id:
          type: string
          nullable: true
        container_id:
          type: string
          nullable: true
        database_id:
          type: string
          nullable: true
        node_id:
          type: string
          nullable: true
        vm_host_id:
          type: string
          nullable: true
        workload_resource_id:
          type: string
          nullable: true
  securitySchemes:
    BearerAuth:
      description: Enter "Bearer {token}"
      type: apiKey
      name: Authorization
      in: header

````

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