TRtrackstarhq
Auth

Get API Logs

Changed on

Returns the API requests your organization made to Trackstar, most recent first. Filter by connection, integration, date range, request path, method, or status.

get/api-logs

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/api-logs
  • Auth
    none required

Query parameters

start_datestring date-time required
Example:2024-01-15T00:00:00Z

Only return requests received at or after this time. Cannot be more than 180 days ago, which is how long we retain logs.

end_datestring date-time
Example:2024-01-16T00:00:00Z

Only return requests received at or before this time. Defaults to now.

connection_idstring
Example:abc123def456abc123def456abc123de

Only return requests made against this connection.

integration_name'active-ants' | 'adp' | 'amazon' | 'amazon-shipping' | 'amphora' | 'amplifier' | 'ams' | 'amware' | 'atomix' | 'bdi' | 'bergen' | 'best-inc' | 'bigblue' | 'bigcommerce' | 'bleckmann' | 'bluebox' | 'boxzooka' | 'byrd' | 'camelot' | 'canary7' | 'capacity' | 'carton-cloud' | 'cin7-omni' | 'cirro' | 'clarus' | 'controlport' | 'crafty' | 'cwr' | 'cybership' | 'dart' | 'darwynn-fulfillment' | 'davinci' | 'dcl' | 'dear-systems' | 'delmarcargo' | 'deposco' | 'dhl-ecom' | 'dhl-express' | 'distribution-alternatives' | 'distribution-management' | 'dotcom-distribution' | 'douyin' | 'dpd' | 'ebay' | 'elite-ops' | 'emerson' | 'eshipping' | 'etsy' | 'everstox' | 'evolve' | 'excelsior' | 'extensiv-3pl-central' | 'fabfitfun' | 'faire' | 'fba' | 'fedex' | 'fedex-fulfillment' | 'ffe' | 'finale' | 'flat-fee-shipping' | 'flexport' | 'florisoft' | 'flowspace' | 'forceget' | 'fulfil' | 'fulfillment' | 'fulfillment-lab' | 'fulfillor' | 'fulfilmentcrowd' | 'fullgood-fulfillment' | 'g-global' | 'geodis' | 'gobolt' | 'greenmark' | 'groupon' | 'helm-wms' | 'hive' | 'i-fulfilment' | 'icreate' | 'ilg' | 'infoplus' | 'itshere' | 'jas' | 'jaygroup' | 'jazz-central' | 'joor' | 'landmark' | 'leanafy' | 'leanware' | 'lineage' | 'linnall' | 'linnworks' | 'logicpod' | 'logiwa' | 'logiwa-io' | 'longtail' | 'luminous' | 'luxroutage' | 'mabang' | 'magento' | 'mai' | 'mainfreight' | 'masonhub' | 'mayple' | 'mintsoft' | 'mirakl' | 'mochila-fulfillment' | 'moda-express' | 'monta' | 'netsuite' | 'next3pl' | 'nextsmartship' | 'nfi' | 'nimble' | 'nlrp' | 'npfulfilment' | 'nri' | 'nuorder' | 'oia-global' | 'omnitrans' | 'ongoing' | 'orderdesk' | 'orderflow' | 'orderwise' | 'osa-commerce' | 'overstock' | 'packem' | 'packiyo' | 'pattern' | 'peoplevox' | 'picqer' | 'pimento' | 'podfoods' | 'portless' | 'postnord' | 'pulpo' | 'qls' | 'quiet' | 'return-helper' | 'rithum-home-depot' | 'rjw' | 'royal-mail' | 'rs-logistics' | 'rush-order' | 'salesupply' | 'sandbox' | 'sellercloud' | 'sg-spedition' | 'shipbob' | 'shipedge' | 'shipfusion' | 'shiphero' | 'shipmonk' | 'shipnetwork' | 'shipoffers' | 'shipout' | 'shipping-and-handling' | 'shipping-tree' | 'shippingbo' | 'shipsidekick' | 'shipstation' | 'shipstream' | 'shipwire' | 'shopify' | 'skladon' | 'skulabs' | 'skusavvy' | 'skuvault' | 'smart-warehousing' | 'smartpack' | 'snapfulfil' | 'sojo' | 'souko' | 'squarespace' | 'star' | 'states-logistics' | 'stock-and-trace' | 'stockhub' | 'stord' | 'stylux' | 'teamship' | 'teapplix' | 'techship' | 'thg-ingenuity-fulfil' | 'tiktok' | 'tlogistics' | 'tps' | 'tradepeg' | 'unis' | 'unleashed' | 'ups' | 'usps' | 'veeqo' | 'veracore' | 'vertical-cold' | 'vox' | 'walmart' | 'warehance' | 'warehouseos' | 'wayfair' | 'whiplash' | 'wineshipping' | 'wix' | 'woocommerce' | 'xorosoft' | 'zenfulfillment' | 'zenventory' | 'zoho'
Example:shipbob

Only return requests made against connections to this integration. The same name can exist across types, so pair it with integration_type to disambiguate.

integration_type'wms' | 'freight' | 'cart' | 'carrier' | 'erp'
Example:wms

Only return requests made against connections of this integration type.

request_method'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS'
Example:GET

Only return requests made with this HTTP method.

request_pathstring
Example:/wms/orders

Only return requests made to this endpoint. Path parameters are replaced with <path_param>, so a request to /wms/orders/123 is stored as /wms/orders/<path_param>.

status_codeinteger
Example:200

Only return requests that returned this HTTP status code.

limitinteger
Example:100

The maximum number of requests to return per page. The default is 100. Minimum 1 and maximum 5000. Fewer may be returned if the page would be too large, in which case a next_token is included.

page_tokenstring
Example:page_token

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

Response

Successful response

total_countinteger required

The number of items returned.

next_tokenstring nullable required

See pagination for more details.

Example response

{
  "data": [
    {
      "request_id": "Root=1-abc12345-abc123def456abc123def456",
      "idempotency_key": "9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00",
      "connection_id": "abc123def456abc123def456abc123de",
      "integration_name": "example_wms",
      "integration_type": "wms",
      "request_time": "2024-01-15T13:45:30Z",
      "request_method": "GET",
      "request_path": "/wms/orders/<path_param>",
      "path_param": "123",
      "query_params": {
        "limit": 100
      },
      "request_body": {
        "reference_id": "order-1001"
      },
      "integration_request_bodies": [
        {
          "url": "https://api.example-wms.com/orders",
          "method": "POST",
          "body": {
            "order_number": "1001"
          }
        }
      ],
      "status_code": 200,
      "error": "Order not found",
      "error_origin": "integration",
      "duration_ms": 142
    }
  ],
  "total_count": 1,
  "next_token": "next_token"
}

Changes