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

# Get market insights

> Returns Upwork market analytics for a period: jobs posted, rates, budgets, connects, categories, skills, countries, client quality and proposal outcomes, with how your team compares. Scope it to the whole market, one of your filters or ad-hoc criteria. Plans with the teaser get 30 days and fewer blocks; access says which one. Counts against the daily market_insights cap



## OpenAPI

````yaml get /market-insights
openapi: 3.0.4
info:
  title: Vollna API
  description: API for managing Upwork profiles, proposals, results, and filters
  version: 1.0.0
servers:
  - url: https://api.vollna.com/v1
security: []
tags:
  - name: Profiles
    description: Manage Upwork profiles
  - name: Proposals
    description: Access and manage Upwork proposals
  - name: Results
    description: View monitoring results and projects
  - name: Filters
    description: Manage monitoring filters
  - name: Auto Bidding
    description: Manage auto bidding jobs and setups
  - name: Account
    description: The token team's account, plan and meters
  - name: Invitations
    description: Upwork invitations
  - name: Projects
    description: Upwork jobs and their competition
  - name: AI Qualifier
    description: A filter's AI qualifier and its verdicts
  - name: Market Insights
    description: Upwork market analytics and saved searches
  - name: Proposal Templates
    description: Proposal templates and their results
paths:
  /market-insights:
    get:
      tags:
        - Market Insights
      summary: Get market insights
      description: >-
        Returns Upwork market analytics for a period: jobs posted, rates,
        budgets, connects, categories, skills, countries, client quality and
        proposal outcomes, with how your team compares. Scope it to the whole
        market, one of your filters or ad-hoc criteria. Plans with the teaser
        get 30 days and fewer blocks; access says which one. Counts against the
        daily market_insights cap
      parameters:
        - name: range
          in: query
          required: false
          description: Period. The teaser always gets 30d
          schema:
            type: string
            enum:
              - 7d
              - 14d
              - 30d
              - 90d
              - 180d
              - 365d
            default: 30d
        - name: audience
          in: query
          required: false
          description: Whose proposals the outcomes count
          schema:
            type: string
            enum:
              - all
              - freelancer
              - agency
            default: all
        - name: filterId
          in: query
          required: false
          description: Scope to one of your filters
          schema:
            type: integer
        - name: verdict
          in: query
          required: false
          description: >-
            Only the filter's jobs with this AI verdict. Needs a filter with a
            qualifier
          schema:
            type: string
            enum:
              - qualified
              - disqualified
        - name: keywords
          in: query
          required: false
          description: Keywords to match
          schema:
            type: string
            maxLength: 200
        - name: categoryIds
          in: query
          required: false
          description: >-
            Upwork category ids, comma-separated (12,40) or repeated
            (categoryIds[]=12)
          schema:
            type: string
        - name: hourlyRateMin
          in: query
          required: false
          description: Minimum hourly rate
          schema:
            type: number
        - name: hourlyRateMax
          in: query
          required: false
          description: Maximum hourly rate
          schema:
            type: number
        - name: fixedBudgetMin
          in: query
          required: false
          description: Minimum fixed budget
          schema:
            type: number
        - name: fixedBudgetMax
          in: query
          required: false
          description: Maximum fixed budget
          schema:
            type: number
        - name: experienceLevels
          in: query
          required: false
          description: 'Comma-separated: 1 entry, 2 intermediate, 3 expert'
          schema:
            type: string
        - name: verifiedOnly
          in: query
          required: false
          description: Only clients with a verified payment method
          schema:
            type: boolean
            default: false
        - name: searchIn
          in: query
          required: false
          description: >-
            Comma-separated fields the keywords match: title, description,
            skills. All three when left out
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      access:
                        type: string
                        description: trial is the teaser
                        enum:
                          - trial
                          - full
                      error:
                        type: boolean
                      range:
                        type: string
                      scope:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - market
                              - filter
                          filterId:
                            type: integer
                            nullable: true
                          filterTitle:
                            type: string
                            nullable: true
                          verdict:
                            type: string
                            nullable: true
                      period:
                        type: object
                        properties:
                          from:
                            type: string
                            format: date
                          to:
                            type: string
                            format: date
                      previousPeriod:
                        type: object
                        properties:
                          from:
                            type: string
                            format: date
                          to:
                            type: string
                            format: date
                        nullable: true
                      updatedAt:
                        type: string
                        format: date-time
                      granularity:
                        type: string
                        enum:
                          - day
                          - week
                          - month
                      kpis:
                        type: object
                      volumeTrend:
                        type: object
                      categories:
                        type: object
                      experienceOverall:
                        type: object
                      jobMix:
                        type: object
                      skills:
                        type: object
                      countries:
                        type: object
                      clientQuality:
                        type: object
                      proposalOutcomes:
                        type: object
                        description: >-
                          View and reply rates of the proposals Vollna users
                          sent in the scope. you holds your team's numbers
                      keywordOpportunities:
                        type: object
                        description: Full access only
                      nicheDifficulty:
                        $ref: '#/components/schemas/NicheDifficulty'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          description: The team has no plan that includes Market Insights
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          description: >-
            The daily market_insights cap is used up, or the rate limit is
            reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
        - apiToken: []
components:
  schemas:
    NicheDifficulty:
      type: object
      description: >-
        How hard a niche is to win, from Upwork's own counts over the last 180
        days
      properties:
        available:
          type: boolean
          description: >-
            false when fewer than 20 jobs in the scope have activity data over
            the last 180 days
        reason:
          type: string
          description: Why the figures are missing; only when available is false
        jobs:
          type: integer
          description: Jobs with activity data in the scope
        avgApplicants:
          type: number
        interviewRatePct:
          type: number
        fillRatePct:
          type: number
        difficulty:
          type: integer
          description: 0 to 100; higher is harder to win
          minimum: 0
          maximum: 100
        crowding:
          type: integer
        odds:
          type: integer
        reliability:
          type: integer
    ServiceError:
      type: object
      properties:
        error:
          type: string
          description: Short error title
          example: Validation failed
        message:
          type: string
          description: What went wrong and what to send instead, written for the user
        fields:
          type: object
          description: >-
            Per-field messages keyed by dot path, when several fields fail at
            once
          additionalProperties:
            type: string
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    BadRequest:
      description: >-
        Invalid request. message says what to send instead; fields names each
        invalid field
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    Unauthorized:
      description: Missing or unknown API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PaymentRequired:
      description: The team's subscription is not active
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Not found in the token's team
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
  securitySchemes:
    apiToken:
      type: apiKey
      name: X-API-TOKEN
      in: header
      description: API token for authentication

````

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