Pagination metadata in response in Rest API - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to include the total number of items in the pagination metadata.

Rest API

{
  "data": items,
  "pagination": {
    "total": [1]
  }
}

Drag options to blanks, or click blank then click option'

Aitems.count()

Btotal_items

Clen(items)

Dcount(items)

Attempts:

3 left

💡 Hint

Common Mistakes

Using a method that does not exist on the list object.

Using a variable name that is not defined.

The len(items) function returns the total number of items in the list, which is used for the pagination metadata.

2fill in blank

medium

Complete the code to add the current page number to the pagination metadata.

Rest API

{
  "data": items,
  "pagination": {
    "page": [1]
  }
}

Drag options to blanks, or click blank then click option'

AcurrentPage

Bpage_number

Cpage

DpageNum

Attempts:

3 left

💡 Hint

Common Mistakes

Using a variable that is not defined in the context.

Using a string literal instead of a variable.

The variable page_number typically holds the current page number in pagination responses.

3fill in blank

hard

Fix the error in the code to correctly include the number of items per page in the pagination metadata.

Rest API

{
  "data": items,
  "pagination": {
    "per_page": [1]
  }
}

Drag options to blanks, or click blank then click option'

ApageSize

BitemsPerPage

CperPage

Dpage_size

Attempts:

3 left

💡 Hint

Common Mistakes

Using variable names that are not defined or inconsistent.

Using snake_case instead of camelCase if the code style requires it.

The variable pageSize is commonly used to represent the number of items per page in pagination metadata.

4fill in blank

hard

Fill both blanks to include the total pages and current page in the pagination metadata.

Rest API

{
  "data": items,
  "pagination": {
    "total_pages": [1],
    "current_page": [2]
  }
}

Drag options to blanks, or click blank then click option'

AtotalPages

BcurrentPage

Cpage_number

Dtotal_pages

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing variable names or using inconsistent naming conventions.

Using string literals instead of variables.

totalPages and page_number are the variables used to represent total pages and current page respectively.

5fill in blank

hard

Fill all three blanks to include total items, items per page, and current page in the pagination metadata.

Rest API

{
  "data": items,
  "pagination": {
    "total_items": [1],
    "items_per_page": [2],
    "current_page": [3]
  }
}

Drag options to blanks, or click blank then click option'

AtotalItems

BitemsPerPage

CcurrentPage

DpageNumber

Attempts:

3 left

💡 Hint

Common Mistakes

Confusing variable names or using inconsistent naming styles.

Using variables that are not defined in the context.

The variables totalItems, itemsPerPage, and currentPage represent total items, items per page, and current page respectively in pagination metadata.

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