Execute a search on a saved search

GET

api

enterprise

opportunities

saved_searches

{id}

Execute a search on a saved search

curl --request GET \
  --url https://app.govly.com/api/enterprise/opportunities/saved_searches/{id}/search \
  --header 'X-API-KEY: <api-key>'

{
  "results": [
    {
      "id": "<string>",
      "aiEstimatedValueMax": 123,
      "aiEstimatedValueMin": 123,
      "aiLineItems": {
        "products": [
          {
            "vendor": "<string>",
            "product": "<string>",
            "quantity": 123,
            "description": "<string>",
            "partNumber": "<string>"
          }
        ],
        "services": [
          {
            "vendor": "<string>",
            "service": "<string>",
            "quantity": 123,
            "description": "<string>",
            "partNumber": "<string>"
          }
        ]
      },
      "aiPeriodOfPerformance": "<string>",
      "aiRawCompetingProducts": [
        "<string>"
      ],
      "aiRawCompetingVendors": [
        {
          "name": "<string>",
          "website": "<string>"
        }
      ],
      "aiRawProducts": [
        "<string>"
      ],
      "aiRawVendors": [
        {
          "name": "<string>",
          "website": "<string>"
        }
      ],
      "aiSummary": "<string>",
      "aiTitle": "<string>",
      "attachments": [
        {
          "checksum": "<string>",
          "filename": "<string>",
          "url": "<string>"
        }
      ],
      "buyer": {
        "id": "<string>",
        "hierarchy": [
          "<string>"
        ],
        "hierarchyIds": [
          "<string>"
        ],
        "name": "<string>"
      },
      "contractVehicle": "<string>",
      "displayName": "<string>",
      "externalIdentifier": "<string>",
      "identifier": "<string>",
      "lastSummarizedAt": "<string>",
      "uniqueKey": "<string>",
      "url": "<string>",
      "modifiedAt": "<string>",
      "highlights": {
        "[field_name]": [
          "<string>"
        ]
      }
    }
  ],
  "meta": {
    "currentPage": 123,
    "per": 123,
    "total": 123,
    "totalPages": 123
  }
}

BETA This endpoint is currently in development and may change in the future.

Request

string

required

ID of the saved search to execute

per

integer

default:50

Number of results per page (max: 100)

page

integer

default:1

Page number for pagination

sort

string

Which date field to use for sorting. Must be one of: ‘relevance’, ‘posted_at’, ‘modified_at’ or ‘respond_by’. Default: falls back to saved search date range parameter

sort_direction

string

default:"desc"

Sort direction for results (‘asc’ or ‘desc’, default: falls back to saved search sort direction)

start_date

string

Start date for filtering results (ISO 8601 format, default: 1 day ago)

end_date

string

End date for filtering results (ISO 8601 format, default: current date)

date_range_param

string

Which date field to use for date range filtering. Must be one of: ‘posted_at’, ‘modified_at’, or ‘respond_by’. Default: falls back to saved search date range parameter

Response

results

array

Array of opportunity objects matching the search criteria

Show Opportunity Properties

string

Unique identifier for the opportunity

aiEstimatedValueMax

float

Maximum estimated value of the opportunity in USD

aiEstimatedValueMin

float

Minimum estimated value of the opportunity in USD

aiLineItems

object

Structured breakdown of products and services mentioned in the opportunity

Show Properties

products

array

Array of product line items

Show Product Properties

vendor

string

Name of the product vendor

product

string

Product name

quantity

number

Quantity requested

description

string

Product description

partNumber

string

Product part number

services

array

Array of service line items

Show Service Properties

vendor

string

Name of the service provider

service

string

Service name

quantity

number

Quantity of services

description

string

Service description

partNumber

string

Service part number

aiPeriodOfPerformance

string

Description of the performance period for the opportunity

aiRawCompetingProducts

string[]

Array of competing product names identified in the opportunity

aiRawCompetingVendors

object[]

Array of competing vendor information

Show Properties

name

string

Vendor name

website

string

Vendor website URL

aiRawProducts

string[]

Array of primary product names mentioned in the opportunity

aiRawVendors

object[]

Array of primary vendor information

Show Properties

name

string

Vendor name

website

string

Vendor website URL

aiSummary

string

AI-generated summary of the opportunity

aiTitle

string

AI-generated descriptive title

attachments

object[]

Array of documents attached to the opportunity

Show Properties

checksum

string

SHA-256 checksum of the file

filename

string

Original filename

url

string

Secure URL to download the attachment

buyer

object

Information about the buying organization

Show Properties

string

Buyer organization ID

hierarchy

string[]

Array of organization names from highest to lowest level

hierarchyIds

string[]

Array of organization IDs corresponding to the hierarchy

name

string

Name of the buying organization

contractVehicle

string

Contract vehicle being used for the opportunity

displayName

string

Human-readable identifier for the opportunity

externalIdentifier

string

External reference number for the opportunity

identifier

string

Internal reference number

lastSummarizedAt

string

ISO 8601 timestamp of when the opportunity was last processed by AI

uniqueKey

string

Unique identifier key for the opportunity

url

string

Web URL for viewing the opportunity

modifiedAt

string

ISO 8601 timestamp of the last modification

highlights

object

Object containing highlighted text snippets from fields that matched the saved search criteria

Show Properties

[field_name]

string[]

Array of text snippets from the field containing highlighted matches. The field name will be the name of the field that contained matches (e.g., ‘title’, ‘description’, etc.)

meta

object

Pagination metadata

Show Properties

currentPage

integer

Current page number

per

integer

Number of items per page

total

integer

Total number of items

totalPages

integer

Total number of pages

List Saved Searches List saved search matches

Execute a search on a saved search

curl --request GET \
  --url https://app.govly.com/api/enterprise/opportunities/saved_searches/{id}/search \
  --header 'X-API-KEY: <api-key>'

{
  "results": [
    {
      "id": "<string>",
      "aiEstimatedValueMax": 123,
      "aiEstimatedValueMin": 123,
      "aiLineItems": {
        "products": [
          {
            "vendor": "<string>",
            "product": "<string>",
            "quantity": 123,
            "description": "<string>",
            "partNumber": "<string>"
          }
        ],
        "services": [
          {
            "vendor": "<string>",
            "service": "<string>",
            "quantity": 123,
            "description": "<string>",
            "partNumber": "<string>"
          }
        ]
      },
      "aiPeriodOfPerformance": "<string>",
      "aiRawCompetingProducts": [
        "<string>"
      ],
      "aiRawCompetingVendors": [
        {
          "name": "<string>",
          "website": "<string>"
        }
      ],
      "aiRawProducts": [
        "<string>"
      ],
      "aiRawVendors": [
        {
          "name": "<string>",
          "website": "<string>"
        }
      ],
      "aiSummary": "<string>",
      "aiTitle": "<string>",
      "attachments": [
        {
          "checksum": "<string>",
          "filename": "<string>",
          "url": "<string>"
        }
      ],
      "buyer": {
        "id": "<string>",
        "hierarchy": [
          "<string>"
        ],
        "hierarchyIds": [
          "<string>"
        ],
        "name": "<string>"
      },
      "contractVehicle": "<string>",
      "displayName": "<string>",
      "externalIdentifier": "<string>",
      "identifier": "<string>",
      "lastSummarizedAt": "<string>",
      "uniqueKey": "<string>",
      "url": "<string>",
      "modifiedAt": "<string>",
      "highlights": {
        "[field_name]": [
          "<string>"
        ]
      }
    }
  ],
  "meta": {
    "currentPage": 123,
    "per": 123,
    "total": 123,
    "totalPages": 123
  }
}

Getting Started

Enterprise

Request

Response

Getting Started

Enterprise

​Request

​Response

Request

Response