Skip to main content
GET
/
v1
/
connect
/
usage
cURL
curl --request GET \
  --url https://api.pipedream.com/v1/connect/usage \
  --header 'Authorization: Bearer <token>'
import { PipedreamClient } from "@pipedream/sdk";

const client = new PipedreamClient({
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET",
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
projectId: "YOUR_PROJECT_ID"
});
await client.usage.list({
startTs: 1,
endTs: 1
});
from pipedream import Pipedream

client = Pipedream(
project_id="YOUR_PROJECT_ID",
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.usage.list(
start_ts=1,
end_ts=1,
)
package com.example.usage;

import com.pipedream.api.BaseClient;
import com.pipedream.api.resources.usage.requests.UsageListRequest;

public class Example {
public static void main(String[] args) {
BaseClient client = BaseClient.withCredentials("<clientId>", "<clientSecret>")
.build()
;

client.usage().list(
UsageListRequest
.builder()
.startTs(1)
.endTs(1)
.build()
);
}
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.pipedream.com/v1/connect/usage"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
{
  "data": [
    {
      "credits_used": 123,
      "usage_start_ts": 123,
      "usage_end_ts": 123,
      "action_run_credits_used": 123,
      "proxy_credits_used": 123,
      "source_emit_credits_used": 123
    }
  ]
}
{
"error": "<string>",
"code": "<string>",
"details": {}
}
{
"error": "Throttled"
}

Authorizations

Authorization
string
header
required

A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.

Query Parameters

start_ts
integer
required

Usage window start timestamp (seconds)

end_ts
integer
required

Usage window end timestamp (seconds)

Response

usage records listed

Connect usage records for a time window

data
object[]
required