32 lines
4.3 KiB
HTML
32 lines
4.3 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>Bitlinks.clicks - bitly-shorten</title>
|
|
<link rel="stylesheet" href="../../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../../index.html">bitly-shorten</a> / <a href="../index.html">net.thauvin.erik.bitly</a> / <a href="index.html">Bitlinks</a> / <a href="./clicks.html">clicks</a><br/>
|
|
<br/>
|
|
<h1>clicks</h1>
|
|
<a name="net.thauvin.erik.bitly.Bitlinks$clicks(kotlin.String, net.thauvin.erik.bitly.Units, kotlin.Int, kotlin.Int, kotlin.String, kotlin.Boolean)"></a>
|
|
<code><span class="identifier">@JvmOverloads</span> <span class="keyword">fun </span><span class="identifier">clicks</span><span class="symbol">(</span><span class="identifier" id="net.thauvin.erik.bitly.Bitlinks$clicks(kotlin.String, net.thauvin.erik.bitly.Units, kotlin.Int, kotlin.Int, kotlin.String, kotlin.Boolean)/bitlink">bitlink</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Bitlinks$clicks(kotlin.String, net.thauvin.erik.bitly.Units, kotlin.Int, kotlin.Int, kotlin.String, kotlin.Boolean)/unit">unit</span><span class="symbol">:</span> <a href="../-units/index.html"><span class="identifier">Units</span></a> <span class="symbol">=</span> Units.DAY<span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Bitlinks$clicks(kotlin.String, net.thauvin.erik.bitly.Units, kotlin.Int, kotlin.Int, kotlin.String, kotlin.Boolean)/units">units</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a> <span class="symbol">=</span> -1<span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Bitlinks$clicks(kotlin.String, net.thauvin.erik.bitly.Units, kotlin.Int, kotlin.Int, kotlin.String, kotlin.Boolean)/size">size</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a> <span class="symbol">=</span> 50<span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Bitlinks$clicks(kotlin.String, net.thauvin.erik.bitly.Units, kotlin.Int, kotlin.Int, kotlin.String, kotlin.Boolean)/unit_reference">unit_reference</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a> <span class="symbol">=</span> Constants.EMPTY<span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Bitlinks$clicks(kotlin.String, net.thauvin.erik.bitly.Units, kotlin.Int, kotlin.Int, kotlin.String, kotlin.Boolean)/toJson">toJson</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> <a href="https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/Bitlinks.kt#L63">(source)</a>
|
|
<p>Returns the click counts for a specified Bitlink.</p>
|
|
<p>See the <a href="https://dev.bitly.com/v4/#operation/getClicksSummaryForBitlink">Bitly API</a> for more information.</p>
|
|
<h3>Parameters</h3>
|
|
<p><a name="bitlink"></a>
|
|
<code>bitlink</code> - The bitlink.</p>
|
|
<p><a name="unit"></a>
|
|
<code>unit</code> - A unit of time.</p>
|
|
<p><a name="units"></a>
|
|
<code>units</code> - An integer representing the time units to query data for. pass -1 to return all units available.</p>
|
|
<p><a name="size"></a>
|
|
<code>size</code> - The quantity of items to be be returned.</p>
|
|
<p><a name="unit_reference"></a>
|
|
<code>unit_reference</code> - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics.
|
|
Will default to current time.</p>
|
|
<p><a name="toJson"></a>
|
|
<code>toJson</code> - Returns the full JSON response if <code>true</code></p>
|
|
<p><strong>Return</strong><br/>
|
|
The click counts or JSON response object.</p>
|
|
</BODY>
|
|
</HTML>
|