Skip to content

Commit

Permalink
Reporting API (WIP)
Browse files Browse the repository at this point in the history
  • Loading branch information
Adspect committed Apr 13, 2024
1 parent 1a237de commit 8f3caac
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions reporting-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ logical **OR** condition, e.g. `os[]=iOS&os[]=macOS` will extract clicks and con

* - `sub_id[]`
- String
- Filter by subaccounts.
- Filter by [subaccount IDs](streams.md#sub-id).

* - `click_id[]`
- String
- Filter by click IDs.
- Filter by [click IDs](streams.md#click-id).

* - `mode[]`
- String
Expand All @@ -102,8 +102,8 @@ logical **OR** condition, e.g. `os[]=iOS&os[]=macOS` will extract clicks and con
* - `target[]`
- Integer
- Filter by displayed page:<br>
0 -- safe page;<br>
1--255 -- money page with the corresponding ordinal number.
0 -- safe page<br>
1--255 -- money page with the corresponding ordinal number
:::

(reporting-sales-funnel)=
Expand Down Expand Up @@ -168,27 +168,27 @@ The following table lists available breakdown columns for the `group_by[]` URL p
- Country code in [two-letter format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

* - `os`
- Operating system name.
- Operating system.

* - `browser`
- Browser name.
- Browser.

* - `engine`
- Browser engine name.
- Browser engine.

* - `language`
- Browser language.

* - `sub_id`
- Subaccount ID.
- [Subaccount ID](streams.md#sub-id).

* - `mode`
- Stream mode at the moment of the click.

* - `target`
- Displayed page:<br>
0 -- safe page;<br>
1--255 -- money page with the corresponding ordinal number.
0 -- safe page<br>
1--255 -- money page with the corresponding ordinal number

* - `tag`
- [Mnemonic tag](reporting.md#tags) representing a particular block reason.
Expand Down Expand Up @@ -300,7 +300,7 @@ GET /reports/funnel?group_by[]=stream_id&metrics[]=clicks&metrics[]=money_hits&m
["9f79b75f-20ef-4654-8141-b8bbb2124ec4", "65", "0", "65", 0]
```

**Example #2:** obtaining basic metrics for the stream with ID `07ac03df-268e-41ff-84ba-adfe2241beb2`:
**Example #2:** obtaining per-day basic metrics for the stream with ID `07ac03df-268e-41ff-84ba-adfe2241beb2`:

```
GET /reports/funnel?group_by[]=date&metrics[]=clicks&metrics[]=money_hits&metrics[]=safe_hits&metrics[]=quality&stream_id[]=07ac03df-268e-41ff-84ba-adfe2241beb2
Expand Down Expand Up @@ -367,7 +367,7 @@ Please specify only those columns that you actually need in your API requests.
- [Autonomous system](https://en.wikipedia.org/wiki/Autonomous_system_(Internet)) number of the visitor.

* - `account_id`
- Account ID of the stream.
- Account ID.

* - `stream_id`
- Stream ID.
Expand All @@ -385,10 +385,10 @@ Please specify only those columns that you actually need in your API requests.
- Browser engine.

* - `languages`
- Array of browser languages.
- List of browser languages.

* - `cost`
- Click cost or payout of the conversion.
- Click cost or conversion payout.

* - `sub_id`
- [Subaccount ID](streams.md#sub-id).
Expand All @@ -401,14 +401,14 @@ Please specify only those columns that you actually need in your API requests.

* - `sequence`
- Click processing stage:<br>
0 -- basic check;<br>
1 -- JavaScript fingerprint check;<br>
255 -- conversion.
0 -- basic check<br>
1 -- JavaScript fingerprint check<br>
255 -- conversion

* - `target`
- Displayed page:<br>
0 -- safe page;<br>
1--255 -- money page with the corresponding ordinal number.
0 -- safe page<br>
1--255 -- money page with the corresponding ordinal number

* - `tags`
- [List of mnemonic tags](reporting.md#tags) that represent particular filtering reasons.
Expand Down

0 comments on commit 8f3caac

Please sign in to comment.