Agrology

Agrology Reports API

The Reports API from Agrology — 5 operation(s) for reports.

GitHub OpenAPI

Operations 8

PUT /report-definitions/{customerID}/{id} Update a specific ReportDefinition #
DELETE /report-definitions/{customerID}/{id} Delete a specific ReportDefinition #
GET /report-definitions/customer/{customerID} Lists ReportDefinitions whose CustomerID matches the provided value #
POST /report-definitions/customer/{customerID} Create a new ReportDefinition #
GET /report-runs/{customerID}/{id} Get info about a specific ReportRun #
GET /report-runs/customer/{customerID} Lists ReportRuns whose CustomerID matches the provided value #
POST /report-runs/customer/{customerID} Create a new ReportRun #
GET /report-runs/report-definition-id/{customerID}/{reportDefinitionID} Lists ReportRuns whose ReportDefinitionID matches the provided value #

Documentation

📖
Documentation
https://github.com/agrology/public-api-docs/blob/main/README.md
📖
APIReference
https://github.com/agrology/public-api-docs/blob/main/openapi.yml
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/authentication/agrology-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/rate-limits/agrology-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/openapi/agrology-reports-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/agrology/public-api-docs
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/scopes/agrology-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/conventions/agrology-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/errors/agrology-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/data-model/agrology-data-model.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/examples/agrology-public-api-examples.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/conformance/agrology-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/lifecycle/agrology-lifecycle.yml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/agrology/refs/heads/main/plans/agrology-plans-pricing.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/agrology-reports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

agrology-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: Agrology Public API v2 Reports API
servers:
- url: https://api.agrology.ag/v2
tags:
- name: Reports
paths:
  /report-definitions/{customerID}/{id}:
    put:
      summary: Update a specific ReportDefinition
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value of the ReportDefinition to update
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The ID value of the ReportDefinition to update
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: string
      security:
      - publicApiAuthorizer: []
      responses:
        '200':
          description: result of the updateReportDefinition operation
          content:
            application/json:
              schema:
                type: string
      tags:
      - Reports
      operationId: putReportDefinitionsByCustomerIDById
      x-operation-id-source: derived
    delete:
      summary: Delete a specific ReportDefinition
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value of the ReportDefinition to delete
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The ID value of the ReportDefinition to delete
        schema:
          type: string
      responses:
        '200':
          description: result of the deleteReportDefinition operation
          content:
            application/json:
              schema:
                type: string
      security:
      - publicApiAuthorizer: []
      tags:
      - Reports
      operationId: deleteReportDefinitionsByCustomerIDById
      x-operation-id-source: derived
  /report-definitions/customer/{customerID}:
    get:
      summary: Lists ReportDefinitions whose CustomerID matches the provided value
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value used to filter the list
        schema:
          type: string
      responses:
        '200':
          description: An array of ReportDefinitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportDefinitions'
      security:
      - publicApiAuthorizer: []
      tags:
      - Reports
      operationId: getReportDefinitionsCustomerByCustomerID
      x-operation-id-source: derived
    post:
      summary: Create a new ReportDefinition
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value used to filter the list
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: string
      responses:
        '201':
          description: result of the createReportDefinition operation
          content:
            application/json:
              schema:
                type: string
      security:
      - publicApiAuthorizer: []
      tags:
      - Reports
      operationId: postReportDefinitionsCustomerByCustomerID
      x-operation-id-source: derived
  /report-runs/{customerID}/{id}:
    get:
      summary: Get info about a specific ReportRun
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value of the ReportRun to retrieve
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The ID value of the ReportRun to retrieve
        schema:
          type: string
      responses:
        '200':
          description: ReportRun Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportRun'
      security:
      - publicApiAuthorizer: []
      tags:
      - Reports
      operationId: getReportRunsByCustomerIDById
      x-operation-id-source: derived
  /report-runs/customer/{customerID}:
    get:
      summary: Lists ReportRuns whose CustomerID matches the provided value
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value used to filter the list
        schema:
          type: string
      responses:
        '200':
          description: An array of ReportRuns
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportRuns'
      security:
      - publicApiAuthorizer: []
      tags:
      - Reports
      operationId: getReportRunsCustomerByCustomerID
      x-operation-id-source: derived
    post:
      summary: Create a new ReportRun
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value used to filter the list
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: string
      responses:
        '201':
          description: result of the createReportRun operation
          content:
            application/json:
              schema:
                type: string
      security:
      - publicApiAuthorizer: []
      tags:
      - Reports
      operationId: postReportRunsCustomerByCustomerID
      x-operation-id-source: derived
  /report-runs/report-definition-id/{customerID}/{reportDefinitionID}:
    get:
      summary: Lists ReportRuns whose ReportDefinitionID matches the provided value
      parameters:
      - name: customerID
        in: path
        required: true
        description: The CustomerID value used to filter the list
        schema:
          type: string
      - name: reportDefinitionID
        in: path
        required: true
        description: The ReportDefinitionID value used to filter the list
        schema:
          type: string
      responses:
        '200':
          description: An array of ReportRuns
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportRuns'
      security:
      - publicApiAuthorizer: []
      tags:
      - Reports
      operationId: getReportRunsReportDefinitionIdByCustomerIDByReportDefinitionID
      x-operation-id-source: derived
components:
  schemas:
    ReportDefinition:
      required:
      - customerID
      - id
      properties:
        id:
          type: string
        customerID:
          type: string
        aggregate:
          type: string
        entryType:
          type: string
        eventBridgeArn:
          type: string
        offsetSecs:
          type: integer
          format: int64
        scope:
          type: string
        targetID:
          type: string
        templateID:
          type: string
    ReportRuns:
      type: array
      items:
        $ref: '#/components/schemas/ReportRun'
    ReportRun:
      required:
      - customerID
      - id
      properties:
        customerID:
          type: string
        id:
          type: string
        ts:
          type: integer
          format: int64
        status:
          type: string
        reportDefinitionID:
          type: string
        executionTime:
          type: integer
          format: int64
    ReportDefinitions:
      type: array
      items:
        $ref: '#/components/schemas/ReportDefinition'
  securitySchemes:
    publicApiAuthorizer:
      type: http
      scheme: bearer
      bearerFormat: JWT