Class default

Index

Constructors

Methods

clickSummary create geoDeviceBreakdown list referrerReport timeSeries update view

Constructors

constructor

new default(): default
Returns default

Methods

`Static` clickSummary

clickSummary<T>(params?): AxiosPromise<default<T>>
Get click-summary report
- Example usage: ShortLinks.clickSummary({ short_link_id: 'uuid-here' })
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:44

`Static` create

create<T>(data, params?): AxiosPromise<default<T>>
Create a new short link
Type Parameters
- T
Parameters
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:17

`Static` geoDeviceBreakdown

geoDeviceBreakdown<T>(params?): AxiosPromise<default<T>>
Get geo & device breakdown report
- Example usage: ShortLinks.geoDeviceBreakdown({ short_link_id: 'uuid-here' })
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:57

`Static` list

list<T>(params?): AxiosPromise<default<T>>
List all short links with optional filters
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:10

`Static` referrerReport

referrerReport<T>(params?): AxiosPromise<default<T>>
Get referrer & UTM report
- Example usage: ShortLinks.referrerReport({ short_link_id: 'uuid-here' })
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:83

`Static` timeSeries

timeSeries<T>(params?): AxiosPromise<default<T>>
Get time-series report
- Example usage: ShortLinks.timeSeries({ short_link_id: 'uuid-here', group_by: 'day' })
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:70

`Static` update

update<T>(id, data, params?): AxiosPromise<default<T>>
Update a short link
Type Parameters
- T
Parameters
- id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:31

`Static` view

view<T>(id, params?): AxiosPromise<default<T>>
Get a specific short link by ID
Type Parameters
- T
Parameters
- id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/ShortLinks.ts:24

Generated using TypeDoc