Usage Statistics

# Get monthly usage statistics (default)
curl -X GET "https://api.docurift.com/v1/credits/usage" \
-H "X-API-Key: frc_your_api_key_here"

# Get daily breakdown for last 7 days
curl -X GET "https://api.docurift.com/v1/credits/usage?period=daily&startDate=2024-01-19" \
-H "X-API-Key: frc_your_api_key_here"

# Get usage grouped by document type
curl -X GET "https://api.docurift.com/v1/credits/usage?groupBy=documentType" \
-H "X-API-Key: frc_your_api_key_here"

# Get weekly usage with both date and document type breakdown
curl -X GET "https://api.docurift.com/v1/credits/usage?period=weekly&groupBy=both" \
-H "X-API-Key: frc_your_api_key_here"

import requests
import os
from datetime import datetime, timedelta

API_KEY = os.getenv('DOCURIFT_API_KEY')
API_URL = 'https://api.docurift.com/v1'

# Get usage statistics for the last 30 days
start_date = (datetime.now() - timedelta(days=30)).strftime('%Y-%m-%d')
end_date = datetime.now().strftime('%Y-%m-%d')

response = requests.get(
  f'{API_URL}/credits/usage',
  headers={'X-API-Key': API_KEY},
  params={
      'period': 'daily',
      'startDate': start_date,
      'endDate': end_date,
      'groupBy': 'both'
  }
)

data = response.json()
stats = data['data']

print(f"Total pages processed: {stats['summary']['totalPages']}")
print(f"Total credits used: {stats['summary']['totalCredits']}")
print(f"Documents processed: {stats['summary']['totalDocuments']}")

# Show breakdown by document type
print("\nBy document type:")
for doc_type, info in stats['byDocumentType'].items():
  print(f"  {doc_type}: {info['pages']} pages ({info['credits']} credits)")

const API_KEY = process.env.DOCURIFT_API_KEY;
const API_URL = 'https://api.docurift.com/v1';

async function getUsageStats(options = {}) {
const params = new URLSearchParams({
  period: options.period || 'monthly',
  groupBy: options.groupBy || 'date',
  ...(options.startDate && { startDate: options.startDate }),
  ...(options.endDate && { endDate: options.endDate })
});

const response = await fetch(
  `${API_URL}/credits/usage?${params}`,
  {
    headers: { 'X-API-Key': API_KEY }
  }
);

return await response.json();
}

// Get daily usage for current month
const now = new Date();
const firstOfMonth = new Date(now.getFullYear(), now.getMonth(), 1);
const stats = await getUsageStats({
period: 'daily',
startDate: firstOfMonth.toISOString().split('T')[0],
groupBy: 'both'
});

console.log('Summary:', stats.data.summary);
console.log('Daily breakdown:', stats.data.byPeriod);
console.log('By document type:', stats.data.byDocumentType);

// Calculate average daily usage
const dailyData = stats.data.byPeriod;
const avgDaily = stats.data.summary.totalCredits / dailyData.length;
console.log(`Average daily usage: ${avgDaily.toFixed(1)} credits`);

{
"success": true,
"data": {
  "summary": {
    "totalCredits": 127,
    "totalPages": 127,
    "totalDocuments": 45,
    "averagePerDocument": 2.8,
    "period": {
      "start": "2024-01-01T00:00:00Z",
      "end": "2024-01-26T23:59:59Z"
    }
  },
  "byPeriod": [
    {
      "date": "2024-01-26",
      "credits": 12,
      "pages": 12,
      "documents": 4
    },
    {
      "date": "2024-01-25",
      "credits": 8,
      "pages": 8,
      "documents": 3
    },
    {
      "date": "2024-01-24",
      "credits": 15,
      "pages": 15,
      "documents": 5
    }
  ],
  "byDocumentType": {
    "invoice": {
      "credits": 65,
      "pages": 65,
      "documents": 25,
      "percentage": 51.2
    },
    "bill_of_lading": {
      "credits": 32,
      "pages": 32,
      "documents": 10,
      "percentage": 25.2
    },
    "packing_list": {
      "credits": 18,
      "pages": 18,
      "documents": 6,
      "percentage": 14.2
    },
    "general": {
      "credits": 12,
      "pages": 12,
      "documents": 4,
      "percentage": 9.4
    }
  }
}
}

{
"success": false,
"error": {
  "code": "INVALID_DATE_RANGE",
  "message": "startDate must be before endDate"
}
}

# Get monthly usage for the year
response = requests.get(
    f'{API_URL}/credits/usage',
    headers={'X-API-Key': API_KEY},
    params={
        'period': 'monthly',
        'startDate': '2024-01-01',
        'endDate': '2024-12-31'
    }
)

response = requests.get(
    f'{API_URL}/credits/usage',
    headers={'X-API-Key': API_KEY},
    params={'groupBy': 'documentType'}
)

for doc_type, stats in response.json()['data']['byDocumentType'].items():
    print(f"{doc_type}: {stats['percentage']:.1f}% of usage")

const stats = await getUsageStats({ period: 'daily', groupBy: 'date' });
const avgDaily = stats.data.summary.totalCredits / stats.data.byPeriod.length;
const projectedMonthly = avgDaily * 30;
console.log(`Projected monthly usage: ${projectedMonthly} credits`);