POST /groups/{group_guid}/exports
Build a CSV export synchronously and return it inline as a base64 data URI plus metadata. The export_type field selects the CSV shape: link_engagements_batch (engagement metrics for explicit bitlinks or a filter), links_list (link metadata roster), or qr_codes_list (QR code metadata roster). Row caps apply per request: 200 rows when metrics are included (link_engagements_batch, or include_metrics on a list export); 1000 rows for metadata-only list exports. When the match set exceeds the cap, truncated is true and only the first cap rows are returned; row_count reports how many data rows are in the CSV.
Servers
- https://api-ssl.bitly.com/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
group_guid |
String | Yes |
A GUID for a Bitly group |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
unix_from |
Integer | No |
Start of the metrics date range (Unix seconds, UTC). Clamped to the caller's tier data window. For link_engagements_batch, required together with unix_to unless the tier max-history default applies. For links_list or qr_codes_list, used when include_metrics is true. |
filter |
Object | No |
Search constraints used to resolve links or QR codes for export. Required for links_list and qr_codes_list. |
filter.query |
String | No |
Free-text search query. |
filter.archived |
String | No |
Filter by archive state. Valid values:
|
filter.campaign_guid |
String | No |
Filter links by campaign GUID. Ignored for qr_codes_list. |
filter.tags[] |
Array | No | |
filter.created_before |
Integer | No |
Include items created before this Unix timestamp (UTC). |
filter.domain |
String | No | |
filter.created_after |
Integer | No |
Include items created at or after this Unix timestamp (UTC). |
bitlinks[] |
Array | No |
Fully qualified bitlinks (e.g. "bit.ly/abc"). Used by export_type link_engagements_batch when the caller already knows the exact links. Mutually exclusive with filter (provide one or the other). |
include_metrics |
Boolean | No |
When true on links_list or qr_codes_list, append clicks, scans, and button_clicks columns and apply the 200-row cap. Requires unix_from and unix_to (or tier-default window behavior where applicable). |
unix_to |
Integer | No |
End of the metrics date range (Unix seconds, UTC). See unix_from. |
export_type |
String | Yes |
Which export shape to produce. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.