Reporting API (WIP)

adspect · Apr 12, 2024 · dd20beb · dd20beb
1 parent c453f65
commit dd20beb
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 32 deletions.
diff --git a/reporting-api.md b/reporting-api.md
@@ -90,7 +90,7 @@ clicks that came from iOS **or** macOS operating systems.
 (reporting-sales-funnel)=
 ### Sales Funnel
 
-```http
+```
 GET /reports/funnel
 ```
 
@@ -99,7 +99,7 @@ the `group_by[]` parameters followed by the order of the `metrics[]` parameters.
 
 The following table lists URL parameters specific to the sales funnel endpoint.
 
-:::{table} Sales Funnel Endpoint URL Parameters
+:::{list-table} Sales Funnel Endpoint URL Parameters
 :header-rows: 1
 
 * - Parameter
@@ -120,11 +120,7 @@ The following table lists URL parameters specific to the sales funnel endpoint.
 
 The following table lists available breakdown columns for the `group_by[]` URL parameter.
 
-:::{tip}
-This list may also be obtained via the [`GET /collections/query-group-by`](api.md#query-group-by) collection endpoint.
-:::
-
-:::{table} Sales Funnel Breakdown Columns
+:::{list-table} Sales Funnel Breakdown Columns
 :header-rows: 1
 
 * - Column
@@ -172,6 +168,10 @@ This list may also be obtained via the [`GET /collections/query-group-by`](api.m
   - [Mnemonic tag](reporting.md#tags) representing a particular block reason.
 :::
 
+:::{tip}
+This list may also be obtained via the [`GET /collections/query-group-by`](api.md#query-group-by) collection endpoint.
+:::
+
 (reporting-sales-funnel-metrics)=
 #### Sales Funnel Metrics
 
@@ -181,12 +181,7 @@ The following table lists available sales funnel metrics for the `metrics[]` URL
 Please specify only those metrics that you actually need in your API requests.
 :::
 
-:::{tip}
-This list may also be obtained via the
-[`GET /collections/query-funnel-metrics` collection endpoint](api.md#query-funnel-metrics-collection).
-:::
-
-:::{table} Sales Funnel Metric Columns
+:::{list-table} Sales Funnel Metric Columns
 :header-rows: 1
 
 * - Column Name
@@ -259,6 +254,11 @@ This list may also be obtained via the
   - Effective cost per mille computed as revenue&nbsp;/&nbsp;clicks&nbsp;×&nbsp;1000.
 :::
 
+:::{tip}
+This list may also be obtained via the
+[`GET /collections/query-funnel-metrics` collection endpoint](api.md#query-funnel-metrics-collection).
+:::
+
 (reporting-sales-funnel-examples)=
 #### Examples
 
@@ -310,7 +310,7 @@ the order of the `columns[]` parameters.
 
 The following table lists URL parameters specific to the click log endpoint.
 
-:::{table} Click Log Endpoint URL Parameters
+:::{list-table} Click Log Endpoint URL Parameters
 :header-rows: 1
 
 * - Parameter
@@ -331,11 +331,7 @@ The following table lists available click log columns for the `columns[]` URL pa
 Please specify only those columns that you actually need in your API requests.
 :::
 
-:::{tip}
-This list may also be obtained via the `GET /collections/query-log-columns` collection endpoint.
-:::
-
-:::{table} Click Log Columns
+:::{list-table} Click Log Columns
 :header-rows: 1
 
 * - Column Name
@@ -398,6 +394,10 @@ This list may also be obtained via the `GET /collections/query-log-columns` coll
   - [List of mnemonic tags](reporting.md#tags) that represent particular filtering reasons.
 :::
 
+:::{tip}
+This list may also be obtained via the `GET /collections/query-log-columns` collection endpoint.
+:::
+
 (reporting-click-log-example)=
 #### Example
 

diff --git a/reporting.md b/reporting.md
@@ -56,7 +56,7 @@ Statistical columns are:
 | CR            | Conversion rate computed as conversions&nbsp;/&nbsp;clicks. |
 | Revenue       | Gross revenue of the funnel as accounted via the postback mechanism. |
 | Profit        | Net profit computed as revenue&nbsp;−&nbsp;cost. |
-| ROI           | Return of investment computed as profit&nbsp;/&nbsp;cost. |
+| ROI           | Return on investment computed as profit&nbsp;/&nbsp;cost. |
 | CPC&nbsp;/&nbsp;CPM | Cost per click computed as cost&nbsp;/&nbsp;clicks, and cost per mille computed as CPC&nbsp;×&nbsp;1000. |
 | CPA           | Cost per action computed as cost&nbsp;/&nbsp;conversions. |
 | EPL           | Earn per lead computed as revenue&nbsp;/&nbsp;conversions. |
@@ -76,11 +76,12 @@ Click log consist of the following columns:
 | IP Address | IP address of the visitor. |
 | ASN        | [Autonomous system](https://en.wikipedia.org/wiki/Autonomous_system_(Internet)) number of the visitor. |
 | Stream     | Name of the stream and a link to it. |
-| Country    | Two-letter country code of the visitor. |
-| OS         | Visitor's operating system. |
-| Browser    | Visitor's browser. |
-| Engine     | Visitor's browser engine. |
-| Cost       | Cost click or payout of the conversion. |
+| Country    | Country code of the visitor in [two-letter format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). |
+| OS         | Operating system name. |
+| Browser    | Browser name. |
+| Engine     | Browser engine name. |
+| Languages  | Browser languages. |
+| Cost       | Click cost or payout of the conversion. |
 | Sub ID     | [Subaccount ID](streams.md#sub-id) of the click. |
 | Click ID   | [Unique ID](streams.md#click-id) of the click. |
 | Mode       | Stream mode at the moment of click. |
@@ -97,14 +98,15 @@ Click log in CSV format consist of the following columns:
 | `stream_id`    | Stream ID. |
 | `ip_address`   | IP address of the visitor. |
 | `asn`          | [Autonomous system](https://en.wikipedia.org/wiki/Autonomous_system_(Internet)) number of the visitor. |
-| `country_code` | Two-letter country code of the visitor. |
-| `os`           | Visitor's operating system. |
-| `browser`      | Visitor's browser. |
-| `engine`       | Visitor's browser engine. |
-| `cost`         | Cost click, if passed via URL parameter. |
-| `sub_id`       | [Subaccount ID](streams.md#sub-id) of the click. |
+| `country_code` | Country code of the visitor in [two-letter format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). |
+| `os`           | Operating system name. |
+| `browser`      | Browser name. |
+| `engine`       | Browser engine name. |
+| `languages`    | Browser languages. |
+| `cost`         | Click cost or payout of the conversion. |
+| `sub_id`       | [Subaccount ID](streams.md#sub-id). |
 | `click_id`     | [Unique ID](streams.md#click-id) of the click. |
-| `mode`         | Stream mode at the moment of click. |
+| `mode`         | Stream mode at the moment of the click. |
 | `sequence`     | Click processing stage: 0&nbsp;for basic checks, 1&nbsp;for JavaScript fingerprint analysis, 255&nbsp;for conversion. |
 | `target`       | Page displayed: 0&nbsp;for safe page, 1--255&nbsp;for money page with the corresponding ordinal number. |
 | `tags`         | [List of mnemonic tags](reporting.md#tags) that represent particular filtering reasons. |