Accounts

Get account activity

Returns account usage, billing estimate, pricing, and recommended next actions for the authenticated account.

get/v1/account/activity

Response

Account activity loaded.

nextActionsstring[] required

Example response

{
  "profile": {
    "accountId": "acct_123",
    "email": "user@example.com",
    "provider": "google",
    "plan": "pro",
    "displayName": null
  },
  "usage": {
    "meters": {
      "hour": {},
      "day": {},
      "week": {},
      "twoWeeks": {},
      "month": {
        "scraper.tiktok.result_records": 1000,
        "scraper.tiktok.cost_usd_micros": 1700000
      },
      "quarter": {}
    }
  },
  "pricing": {
    "subscriptionUsdCentsPerMonth": 2000,
    "planBalanceUsdCentsPerMonth": 2000,
    "bonusBalanceUsdCentsPerMonth": 0,
    "includedBalanceUsdCentsPerMonth": 2000,
    "paidOveragesEnabled": false
  },
  "billingEstimate": {
    "currency": "USD",
    "plan": "plus",
    "paidOveragesEnabled": false,
    "subscriptionUsdMicrosPerMonth": 20000000,
    "planBalanceUsdCentsPerMonth": 2000,
    "bonusBalanceUsdCentsPerMonth": 0,
    "includedBalanceUsdCentsPerMonth": 2000,
    "topUpBalanceUsdMicros": 0,
    "topUpMinimumUsdCents": 2000,
    "topUpMaximumUsdCents": 100000,
    "topUpExpiresAfterInactiveDays": 365,
    "autoTopUpEnabled": false,
    "autoTopUpThresholdUsdCents": 500,
    "autoTopUpAmountUsdCents": 2000,
    "autoTopUpMonthlyLimitUsdCents": 100000,
    "currentMonthBonusBalanceUsedUsdMicros": 0,
    "currentMonthPlanBalanceUsedUsdMicros": 1700000,
    "currentMonthTopUpBalanceUsedUsdMicros": 0,
    "currentMonthOverageUsdMicros": 0,
    "estimatedMonthlyTotalUsdMicros": 20000000,
    "lineItems": [
      {
        "product": "tiktok",
        "meter": "scraper_result_records",
        "currentMonthUsed": 1000,
        "includedPerMonth": null,
        "billableAmount": 1000,
        "usageUnit": "result",
        "billingUnit": "result",
        "billingUnitSize": 1,
        "priceUsdMicrosPerBillingUnit": null,
        "estimatedUsdMicros": 1700000,
        "estimateBasis": "stored_scrape_requests",
        "rounding": "actual_scraper_cost"
      }
    ],
    "nextActions": [
      "plus scraper usage is within monthly balance. Bonus balance is spent before paid plan balance.",
      "Fetch saved results or create another public-data scraper request when you need fresh data."
    ]
  },
  "nextActions": [
    "Run `tovuk request results <request-id> --json` to fetch stored results.",
    "Run `tovuk scraper list --json` before creating another paid scraper request."
  ]
}

Changes

Changed in 5 of the 50 revisions of this API.29788

  • c7b37eaf7c38326See the full diff
    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • deleted the query request parameter cursor

      request-parameter-removed

    • deleted the query request parameter limit

      request-parameter-removed

    • api operation id listAccountActivity removed and replaced with getAccountActivity

      api-operation-id-removed

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3985c6090c9126578See the full diff
    • for the query request parameter cursor, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property's maxLength was unset from 1000 for the response status

      response-property-max-length-unset

    • the response property's maxLength was unset from 1000 for the response status

      response-property-max-length-unset

    • the response property's maxLength was unset from 1000 for the response status

      response-property-max-length-unset

    • the response property's maxLength was unset from 1000 for the response status

      response-property-max-length-unset

    • the response property's maxLength was unset from 240 for the response status

      response-property-max-length-unset

    • the response property's maxLength was unset from 240 for the response status

      response-property-max-length-unset

    • the response property's maxLength was unset from 240 for the response status

      response-property-max-length-unset

    • the response property's maxLength was unset from 240 for the response status

      response-property-max-length-unset

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • the optional response header Retry-After removed for the status 200

      optional-response-header-removed

    • the optional response header Retry-After removed for the status 400

      optional-response-header-removed

    • the optional response header Retry-After removed for the status 401

      optional-response-header-removed

    • the optional response header Retry-After removed for the status 500

      optional-response-header-removed

    • changed the pattern of the query request parameter cursor from ^[0-9A-Za-z_:-]{1,128}$ to ^[\s\S]{0,8192}$

      request-parameter-pattern-changed

    • api operation id getAccountActivity removed and replaced with listAccountActivity

      api-operation-id-removed

    • for the query request parameter limit, the max was increased from 200.00 to 1000.00

      request-parameter-max-increased

    • for the query request parameter cursor, the maxLength was increased from 128 to 512

      request-parameter-max-length-increased

    • removed the database_unavailable enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the database_unavailable enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the database_unavailable enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the database_unavailable enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_cpu_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_cpu_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_cpu_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_cpu_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_health_endpoint enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_health_endpoint enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_health_endpoint enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_health_endpoint enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_memory_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_memory_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_memory_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_memory_limit enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_port enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_port enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_port enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_port enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_service_name enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_service_name enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_service_name enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_service_name enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_toml enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_toml enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_toml enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the invalid_toml enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_command enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_command enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_command enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_command enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_config enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_config enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_config enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_config enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_source_archive enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_source_archive enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_source_archive enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the missing_source_archive enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the payment_required enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the payment_required enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the payment_required enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the payment_required enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the policy_rejected enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the policy_rejected enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the policy_rejected enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the policy_rejected enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the rate_limited enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the rate_limited enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the rate_limited enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the rate_limited enum value from the response property for the response status

      response-property-enum-value-removed

    • response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 400

      response-property-list-of-types-narrowed

    • response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 401

      response-property-list-of-types-narrowed

    • response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 429

      response-property-list-of-types-narrowed

    • response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 500

      response-property-list-of-types-narrowed

    • response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 400

      response-property-list-of-types-narrowed

    • response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 401

      response-property-list-of-types-narrowed

    • response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 429

      response-property-list-of-types-narrowed

    • response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 500

      response-property-list-of-types-narrowed

    • the response's property pattern ^[\s\S]{0,8192}$ was added for the status

      response-property-pattern-added

    • the response's property pattern ^[\s\S]{0,8192}$ was added for the status

      response-property-pattern-added

    • the response's property pattern ^[\s\S]{0,8192}$ was added for the status

      response-property-pattern-added

    • the response's property pattern ^[\s\S]{0,8192}$ was added for the status

      response-property-pattern-added

    • the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status

      response-property-pattern-changed

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 141 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property // to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog