# Sales and statistics

> Reference generated from the OpenAPI contract: Sales and statistics.

URL : https://docs.fanconvert.ai/en/api/reference/ventes-et-statistiques

{/* Généré par scripts/generer-reference.mjs depuis openapi/public-v1.json : ne pas modifier à la main. */}

## Les ventes, par plateforme [#les-ventes-par-plateforme]

`GET /public/v1/sales` · `listSales`

### Parameters [#parameters]

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `platform` | query | "mym" \| "telegram" \| "onlyfans" \| "fanvue" | no |  (default : `mym`) |
| `creatorId` | query | string \| null | no | Filtre. |
| `from` | query | string (date-time) \| null | no | MYM seulement. |
| `to` | query | string (date-time) \| null | no | MYM seulement. |
| `limit` | query | integer | no | Taille de la page. (default : `50`) |
| `cursor` | query | string \| null | no | Le `nextCursor` de la page précédente. |

### Response 200 [#response-200]

**`SalesPage`**

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | Sale[] | yes |  |
| `nextCursor` | string \| null | no | À repasser en `cursor` pour lire la page suivante ; null = dernière page. |
| `platform` | "mym" \| "telegram" \| "onlyfans" \| "fanvue" | yes |  |
| `currency` | string | yes |  |
| `totalMinor` | integer \| null | no | Total de la période, quand la plateforme le donne. |

**`Sale`**

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes |  |
| `platform` | "mym" \| "telegram" \| "onlyfans" \| "fanvue" | yes |  |
| `creatorId` | string | yes |  |
| `conversationId` | string \| null | yes |  |
| `at` | string (date-time) \| null | yes |  |
| `amountMinor` | integer | yes | Montant payé, en unité mineure de la devise (centimes ; Stars pour XTR). |
| `currency` | string | yes |  |
| `kind` | string \| null | no | Ce qui a été payé : média, pourboire, abonnement… |
| `refundedAt` | string (date-time) \| null | no |  |

### Possible errors [#possible-errors]

`401` · `403` · `404` · `422` · `429` · `503` — Error format: [Errors](/en/api/rest/erreurs).

### Example [#example]

```bash
curl -X GET "https://app.fanconvert.ai/public/v1/sales" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"
```

## Revenus et envois par créatrice sur une période [#revenus-et-envois-par-créatrice-sur-une-période]

`GET /public/v1/statistics/creators` · `listCreatorStatistics`

### Parameters [#parameters-1]

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `from` | query | string (date-time) | yes |  |
| `to` | query | string (date-time) | yes |  |
| `platform` | query | "mym" \| "telegram" \| "onlyfans" \| "fanvue" | no |  (default : `mym`) |

### Response 200 [#response-200-1]

**`Page_CreatorStats_`**

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | CreatorStats[] | yes |  |
| `nextCursor` | string \| null | no | À repasser en `cursor` pour lire la page suivante ; null = dernière page. |

**`CreatorStats`**

| Field | Type | Required | Description |
|---|---|---|---|
| `creatorId` | string | yes |  |
| `name` | string | yes |  |
| `platform` | string | yes |  |
| `currency` | string | yes |  |
| `revenueMinor` | integer | yes |  |
| `sales` | integer | yes |  |
| `messagesSent` | integer | yes |  |
| `paidMediaSent` | integer | yes |  |
| `freeMediaSent` | integer | yes |  |

### Possible errors [#possible-errors-1]

`401` · `403` · `404` · `422` · `429` · `503` — Error format: [Errors](/en/api/rest/erreurs).

### Example [#example-1]

```bash
curl -X GET "https://app.fanconvert.ai/public/v1/statistics/creators" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"
```

