erik/bitly-shorten
erik/bitly-shorten
1
1
Fork 0
Code Issues Releases Activity

Added docs.

Browse source
This commit is contained in:
Erik C. Thauvin 2020-03-03 00:32:15 -08:00
parent dd0079e7e8
commit 95bea38c92
37 changed files with 521 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/net.thauvin.erik.bitly/-bitlinks/clicks.md Normal file
View file

@ -0,0 +1,28 @@
[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [Bitlinks](index.md) / [clicks](./clicks.md)
# clicks
`@JvmOverloads fun clicks(bitlink: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, unit: `[`Units`](../-units/index.md)` = Units.DAY, units: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = -1, size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 50, unit_reference: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, toJson: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/Bitlinks.kt#L63)
Returns the click counts for a specified Bitlink.
See the [Bitly API](https://dev.bitly.com/v4/#operation/getClicksSummaryForBitlink) for more information.
### Parameters
`bitlink` - The bitlink.
`unit` - A unit of time.
`units` - An integer representing the time units to query data for. pass -1 to return all units available.
`size` - The quantity of items to be be returned.
`unit_reference` - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics.
Will default to current time.
`toJson` - Returns the full JSON response if `true`
**Return**
The click counts or JSON response object.