Pagination metadata in response in Rest API

Introduction

Pagination metadata helps you split large lists into smaller parts and tells you about the current page and total pages.

When you have many items and want to show them page by page.

When you want to let users navigate through a list without loading everything at once.

When your app needs to load data faster by fetching small chunks.

When you want to show how many pages or items are left to browse.

Syntax

Rest API

{
  "data": [ ...items... ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_items": 100,
    "total_pages": 10
  }
}

The data field holds the current page items.

The pagination object gives info about pages and items.

Examples

This shows page 1 with 2 items per page out of 5 total items.

Rest API

{
  "data": ["apple", "banana"],
  "pagination": {
    "current_page": 1,
    "per_page": 2,
    "total_items": 5,
    "total_pages": 3
  }
}

This shows page 3 with no items (maybe last page is empty).

Rest API

{
  "data": [],
  "pagination": {
    "current_page": 3,
    "per_page": 10,
    "total_items": 25,
    "total_pages": 3
  }
}

Sample Program

This simple API returns items in pages with pagination info.

Try changing page and per_page in the URL to see different results.

Rest API

from flask import Flask, request, jsonify

app = Flask(__name__)

items = [f"item{i}" for i in range(1, 26)]  # 25 items

@app.route('/items')
def get_items():
    page = int(request.args.get('page', 1))
    per_page = int(request.args.get('per_page', 10))
    total_items = len(items)
    total_pages = (total_items + per_page - 1) // per_page
    start = (page - 1) * per_page
    end = start + per_page
    data = items[start:end]
    response = {
        "data": data,
        "pagination": {
            "current_page": page,
            "per_page": per_page,
            "total_items": total_items,
            "total_pages": total_pages
        }
    }
    return jsonify(response)

# To test, run this app and visit /items?page=2&per_page=10

Important Notes

Always include total items and total pages so clients know how much data exists.

Use current_page and per_page to control which items to send.

Empty data array means no items on that page, maybe page number is too high.

Summary

Pagination metadata helps break big lists into smaller pages.

It tells clients which page they are on and how many pages exist.

This makes data easier and faster to load and use.

Practice

1.

What is the main purpose of including pagination metadata in a REST API response?

easy

A. To inform the client about the current page and total pages available

B. To encrypt the data for security reasons

C. To compress the response size for faster transmission

D. To validate the user's authentication token

Solution

1. Step 1: Understand pagination metadata role

   Pagination metadata provides information about the current page, total pages, and items per page to help clients navigate large data sets.

2. Step 2: Identify the correct purpose

   Among the options, only informing the client about page details matches the role of pagination metadata.

3. Final Answer:

   To inform the client about the current page and total pages available -> Option A

4. Quick Check:

   Pagination metadata = page info [OK]

Hint: Pagination metadata tells page info, not security or compression [OK]

Common Mistakes:

• Confusing pagination metadata with security features
• Thinking it compresses data
• Assuming it validates user tokens

2.

Which of the following is the correct JSON structure for pagination metadata in a REST API response?

{
  "data": [...],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "per_page": 10
  }
}

easy

A. { "pagination": "page 1 of 5" }

B. { "page": 1, "pages": 5, "size": 10 }

C. { "pagination": [1, 5, 10] }

D. { "pagination": { "current_page": 1, "total_pages": 5, "per_page": 10 } }

Solution

1. Step 1: Check JSON structure for pagination metadata

   The correct structure uses a nested object with keys like current_page, total_pages, and per_page to clearly describe pagination details.

2. Step 2: Compare options to the example

   { "pagination": { "current_page": 1, "total_pages": 5, "per_page": 10 } } matches the example with a nested object and descriptive keys, while others use incorrect formats or data types.

3. Final Answer:

   { "pagination": { "current_page": 1, "total_pages": 5, "per_page": 10 } } -> Option D

4. Quick Check:

   Pagination metadata = nested object with page info [OK]

Hint: Look for nested object with clear keys for pagination [OK]

Common Mistakes:

• Using arrays instead of objects for metadata
• Using strings instead of structured data
• Omitting descriptive keys

3.

Given this REST API response snippet, what is the value of response.pagination.total_pages?

{
  "data": [{"id":1}, {"id":2}],
  "pagination": {
    "current_page": 2,
    "total_pages": 4,
    "per_page": 2
  }
}

medium

A. 2

B. 4

C. 1

D. Undefined

Solution

1. Step 1: Locate the total_pages key in the response

   Within the pagination object, total_pages is set to 4.

2. Step 2: Confirm the value of total_pages

   The value 4 indicates the total number of pages available in the data set.

3. Final Answer:

   4 -> Option B

4. Quick Check:

   total_pages = 4 [OK]

Hint: Find total_pages key inside pagination object [OK]

Common Mistakes:

• Confusing current_page with total_pages
• Assuming total_pages is the length of data array
• Missing the nested pagination object

4.

Identify the error in this pagination metadata snippet and select the fix:

{
  "data": [...],
  "pagination": {
    "currentPage": 1,
    "totalPages": 3,
    "perPage": 10
  }
}

medium

A. Remove the pagination object completely

B. Change values to strings instead of numbers

C. Change keys to snake_case: current_page, total_pages, per_page

D. Add a new key called page_count

Solution

1. Step 1: Check key naming conventions in pagination metadata

   Standard REST API pagination metadata uses snake_case keys like current_page, total_pages, and per_page for consistency.

2. Step 2: Identify the fix for camelCase keys

   Changing currentPage, totalPages, perPage to snake_case fixes the inconsistency and aligns with common API practices.

3. Final Answer:

   Change keys to snake_case: current_page, total_pages, per_page -> Option C

4. Quick Check:

   Use snake_case keys for pagination metadata [OK]

Hint: Use snake_case keys for pagination metadata [OK]

Common Mistakes:

• Leaving camelCase keys in metadata
• Removing pagination metadata entirely
• Changing numeric values to strings unnecessarily

5.

You have an API returning 45 items with per_page set to 10. How many pages should the total_pages metadata show?

hard

A. 5

B. 6

C. 4

D. 10

Solution

1. Step 1: Calculate total pages from total items and per_page

   Total pages = total items divided by items per page, rounded up. Here, 45 / 10 = 4.5, rounded up to 5.

2. Step 2: Confirm the correct total_pages value

   Since 4 pages would only cover 40 items, 5 pages are needed to cover all 45 items.

3. Final Answer:

   5 -> Option A

4. Quick Check:

   Ceil(45/10) = 5 pages [OK]

Hint: Divide total items by per_page, round up [OK]

Common Mistakes:

• Using floor division instead of ceiling
• Ignoring leftover items on last page
• Assuming total_pages equals per_page