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

# List usage records

> One record per charge, newest first: items, unit price and total cost. Every filter is optional.



## OpenAPI

````yaml /openapi.json get /api/v1/usage/
openapi: 3.0.3
info:
  title: Go-Fetch API
  version: v1
servers:
  - url: https://go-fetch.io
security: []
tags:
  - name: Jobs
    description: >-
      A job is one scrape. Create it with a scraper type and its input, follow
      it until it is completed, failed, timed_out or cancelled, then page
      through its results.
  - name: Webhooks
    description: >-
      URLs we POST to when a job finishes, signed with your webhook secret in
      the X-Webhook-Signature header, and the log of every delivery.
  - name: Usage
    description: Billable usage, one record per charge.
  - name: Pricing
    description: List prices per platform and a cost estimate. No API key needed.
  - name: API keys
    description: >-
      Your organization's API keys. Creating, changing and rotating a key needs
      a key with the admin scope.
  - name: Organizations
    description: >-
      The organization your key belongs to: its environments, members, this
      month's usage and the audit log.
paths:
  /api/v1/usage/:
    get:
      tags:
        - Usage
      summary: List usage records
      description: >-
        One record per charge, newest first: items, unit price and total cost.
        Every filter is optional.
      operationId: usage_list
      parameters:
        - in: query
          name: created_after
          schema:
            type: string
          description: ISO date or datetime, inclusive; `start_date` is an alias.
        - in: query
          name: created_before
          schema:
            type: string
          description: >-
            ISO date or datetime, inclusive; a date covers the whole day.
            `end_date` is an alias.
        - in: query
          name: environment
          schema:
            type: string
          description: An environment slug.
        - in: query
          name: job
          schema:
            type: string
          description: A job id.
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - in: query
          name: platform
          schema:
            type: string
          description: A scraper type; `scraper_type` is an alias.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUsageRecordList'
          description: ''
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PaginatedUsageRecordList:
      type: object
      required:
        - total
        - offset
        - limit
        - count
        - results
      properties:
        total:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        count:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/UsageRecord'
    UsageRecord:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        event_id:
          type: string
          description: Unique event ID from scraper (prevents duplicates)
          maxLength: 255
        organization:
          type: string
          format: uuid
          nullable: true
        job:
          type: string
          format: uuid
          nullable: true
          description: Job that generated this usage
        environment:
          type: string
          format: uuid
          nullable: true
        environment_name:
          type: string
          readOnly: true
        platform:
          type: string
        posts_scraped:
          type: integer
          minimum: 0
          description: Number of posts/videos scraped
        unit_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,4}(?:\.\d{0,6})?$
          description: Price per post at time of usage (USD)
        total_cost:
          type: string
          format: decimal
          pattern: ^-?\d{0,6}(?:\.\d{0,4})?$
          description: 'Total cost: posts_scraped * unit_price (USD)'
        plan_name:
          type: string
          description: Plan name at time of usage
          maxLength: 100
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - created_at
        - environment_name
        - event_id
        - id
        - plan_name
        - platform
        - total_cost
        - unit_price
        - updated_at
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

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