mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-09 04:19:43 +00:00
58 lines
5.2 KiB
Markdown
58 lines
5.2 KiB
Markdown
# Analytics
|
|
(*analytics*)
|
|
|
|
### Available Operations
|
|
|
|
* [retrieve](#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.
|
|
|
|
## retrieve
|
|
|
|
Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.retrieve({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.RetrieveAnalyticsRequest](../../models/operations/retrieveanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise\<[operations.RetrieveAnalyticsResponseBody](../../models/operations/retrieveanalyticsresponsebody.md)\>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|