# Count API (schema)

> Count the rows matching a filter with the schema count API of API Maker - a find in the body, a number in the answer, on every database.

Source: https://docs.apimaker.dev/v1/docs/apis-all/schema-apis/auto-generated-schema-based-count-api.html

Answers how many rows match `find`, without reading them.

| | |
|---|---|
| Method | POST |
| URL | `/api/schema/admin/mysql8/inventory/customers/count` |
| Body | `{ find }` |
| Query params | none |
| Answer | `data` : the number of rows |
| Databases | MongoDB, MySQL, MariaDB, PostgreSQL, SQL Server, Oracle, TiDB, Percona |
| Cached | yes, with `enableCaching` on the table |
| From code | [`g.sys.db.count`](https://docs.apimaker.dev/v1/examples/sys/db/count.html) |
| API id | `SCHEMA_POST_COUNT` (groups, settings, hooks, WebSocket subscriptions) |
| The other family | [Count as a generated API](https://docs.apimaker.dev/v1/docs/apis-all/generated-apis/auto-generated-count-api.html) |

> **Generated (`/api/gen`) or schema (`/api/schema`) ?**
>
> Both families offer the same operations on the same URL pattern. The **schema APIs** read the [schema](https://docs.apimaker.dev/v1/docs/schema/schema.html) of the table : values are converted to their types, validated, encrypted, defaulted and numbered before they reach the database. The **generated APIs** are schemaless : they pass your data as it is, so a number sent as `"22"` stays a string. Use the schema APIs for the tables your application writes to, and the generated APIs for quick reads and for tables without a schema.

## The URL

`/api/schema/admin/mysql8/inventory/customers/count` : replace `admin` with the user path of your account, `mysql8` with your instance, `inventory` with the database and `customers` with the table. The examples use this table :

| customer_id | first_name | last_name | last_update           | pincode | isActive |
|-------------|------------|-----------|-----------------------|---------|----------|
| 1           | Bob        | lin       | 2022-11-14 04: 34: 58 | 382345  | 1        |
| 2           | Alice      | Page      | 2022-10-15 02: 10: 40 | 382346  | 1        |
| 3           | Mallory    | Brown     | 2022-09-13 03: 44: 05 | 382347  | 1        |
| 4           | Eve        | Mathly    | 2022-11-12 01: 59: 33 | 382348  | 1        |
| 5           | Eve        | Page      | 2022-11-12 01: 59: 33 | 382349  | 1        |

## The call

```text
POST /api/schema/admin/mysql8/inventory/customers/count
```

**Body**

```json
{ "find": { "isActive": 1 } }
```

**Answer**

```json
{ "success": true, "statusCode": 200, "data": 5 }
```

- `find` takes every operator of [find](https://docs.apimaker.dev/v1/docs/apis-all/query-params/find.html) : `$gt`, `$in`, `$and`, `$or`, `$like`, dotted keys of related tables… `{ "find": {} }` counts the table.

## Examples

```json
{ "find": { "pincode": { "$gte": 382345 } } }
```

```json
{ "find": { "$or": [ { "first_name": "Bob" }, { "first_name": "Alice" } ] } }
```

```json
{ "find": { "first_name": { "$like": "%all%" } } }
```

**rows whose orders are paid**

```json
{ "find": { "orders.status": "PAID" } }
```

## Types in the filter

- The values are converted with the schema : `"pincode": "100050"` counts the number 100050.

## Good to know

- For a list with its total in one call, [query](https://docs.apimaker.dev/v1/docs/apis-all/schema-apis/auto-generated-schema-based-query-for-get-data-api.html) with `getTotalCount: true` saves the second request.
- With caching on, the count answers from Redis until a write changes the table.

## From your code

[`g.sys.db.count`](https://docs.apimaker.dev/v1/examples/sys/db/count.html) makes the same call from custom APIs, hooks, events, schedulers and test cases, with the same headers and params. Pass `true` as the second argument to get the whole [response envelope](https://docs.apimaker.dev/v1/docs/apis-all/response-format.html) instead of `data`.

## Headers

Every call takes the [request headers](https://docs.apimaker.dev/v1/docs/apis-all/header/requestHeader.html) : the tokens, `x-am-response-case`, `x-am-content-type-response` (JSON, XML, YAML…), `x-am-response-object-type: make_flat`, `x-am-cache-control`, `x-am-get-encrypted-data`, `x-am-internationalization`, `x-am-tenant-username`, `x-am-meta`.

## Errors

| Code | When |
|---|---|
| `401` | The token in `x-am-authorization` is missing or invalid. |
| `403` | No group of the API user grants this API of this table, or a field of the request. |
| `404` | The instance, database or table of the URL does not exist, or the table has no schema (use `/api/gen`). |
| `400` | The query or the body is wrong : the [error messages](https://docs.apimaker.dev/v1/docs/apis-all/error-codes.html) say which key and why. |

## Related

- [All APIs at a glance](https://docs.apimaker.dev/v1/docs/apis-all/overview.html) · [Query params](https://docs.apimaker.dev/v1/docs/apis-all/query-params/query-params.html) · [Response format](https://docs.apimaker.dev/v1/docs/apis-all/response-format.html) · [Pre hooks](https://docs.apimaker.dev/v1/docs/apis-all/hooks/preHook-api.html) and [post hooks](https://docs.apimaker.dev/v1/docs/apis-all/hooks/postHook-api.html) · [Automatic caching](https://docs.apimaker.dev/v1/docs/features/automatic-caching.html)
- [Table schema](https://docs.apimaker.dev/v1/docs/schema/schema.html) : what the conversions and validations do to every write.