> ## 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 series

> Returns the endpoint's traffic per time bucket, oldest first, both roles combined. bytes_out and packets_out are what the endpoint sent and bytes_in and packets_in what it received. cost prices the bucket's bytes at each connection's attributed rate and is null when nothing in the bucket is priced. by_locality and by_mechanism split the bucket's bytes and cost by where the traffic went and by how it was charged. Buckets with no traffic are absent, and hourly source data is retained for 90 days



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/service-map/endpoints/{id}/series
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}/series:
    get:
      tags:
        - service-map
      summary: Get network endpoint series
      description: >-
        Returns the endpoint's traffic per time bucket, oldest first, both roles
        combined. bytes_out and packets_out are what the endpoint sent and
        bytes_in and packets_in what it received. cost prices the bucket's bytes
        at each connection's attributed rate and is null when nothing in the
        bucket is priced. by_locality and by_mechanism split the bucket's bytes
        and cost by where the traffic went and by how it was charged. Buckets
        with no traffic are absent, and hourly source data is retained for 90
        days
      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: 'Bucket size: hour, day, week, or month (default hour)'
          name: resolution
          in: query
          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.Series'
        '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.Series:
      type: object
      properties:
        points:
          type: array
          items:
            $ref: '#/components/schemas/networkendpoint.SeriesPoint'
        range:
          $ref: '#/components/schemas/networkendpoint.Range'
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    networkendpoint.SeriesPoint:
      type: object
      properties:
        bucket_start:
          type: string
        by_locality:
          type: array
          items:
            $ref: '#/components/schemas/networkendpoint.Breakdown'
        by_mechanism:
          type: array
          items:
            $ref: '#/components/schemas/networkendpoint.Breakdown'
        bytes_in:
          type: number
        bytes_out:
          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
        failure_rate:
          type: number
          nullable: true
        packets_in:
          type: number
        packets_out:
          type: number
    networkendpoint.Range:
      type: object
      properties:
        end:
          type: string
        start:
          type: string
    networkendpoint.Breakdown:
      type: object
      properties:
        bytes:
          type: number
        cost:
          type: number
          x-semantic: costAmount
          nullable: true
        key:
          type: string
  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.