💼

reports

Business report document containing analysis, metrics, or summaries. Tracks report metadata, creator, department, reporting period, status, and file location.

🎯 Request Builder

https://api.mockly.codes/reports?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/reports

Get a collection of reports

Alternative: /business/reports
GET/reports/:id

Get a single report by ID

Alternative: /business/reports/:id
GET/reports/meta

Get resource metadata and schema

Alternative: /business/reports/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/reports?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/reports?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 reports
fetch('https://api.mockly.codes/reports?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/reports?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/reports?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/reports?nocache=true')

Schema Properties

idinteger

Unique identifier for the report record

Gen:random_int
titlestring

Title or name of the report

Gen:sentence
typestring

Type or category of report (e.g., financial, sales, performance, audit, quarterly)

Gen:word
descriptionstring

Summary or overview of what the report contains and its purpose

Gen:paragraph
created_bystring

Full name of the person who authored or created the report

Gen:name
departmentstring

Department or division that generated or owns this report

Gen:department
period_startstring

Start date of the reporting period covered by this report

Gen:past_datedate
period_endstring

End date of the reporting period covered by this report

Gen:past_datedate
statusstring

Current status of the report (e.g., draft, final, published, archived)

Gen:status
file_urlstring

URL or file path where the report document is stored (PDF, Excel, etc.)

Gen:urluri
created_atstring

Timestamp when the report was created

Gen:past_datedate-time

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request