","directories":{},"_nodeVersion":"18.13.0","dependencies":{"@apitraffic/utilities":"^0.2.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_0.0.12_1721790997886_0.7753183669150887","host":"s3://npm-registry-packages"}},"0.0.13":{"name":"@apitraffic/express","version":"0.0.13","author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","_id":"@apitraffic/express@0.0.13","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"homepage":"https://github.com/apitraffic/apitraffic-express#readme","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"dist":{"shasum":"371cca1cb9490864bb475387e097299728b9f602","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-0.0.13.tgz","fileCount":966,"integrity":"sha512-PDw3ygYYBAaUDVH5+1bqCQMDvx5EwxPOqrw8SZLM/+6fhrhRAWg0NCOwQB/i0MQWogLF4hRls2XKVcBd+Cwy4w==","signatures":[{"sig":"MEQCIDye97051yTLtAoaq38JcPqNZ26jc6skKCugwOylNpQ/AiAXEJv1R6TDRPJ0PzCLuuzy7PNm+b4/w0aUTHMDFhK+Jw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5828422},"main":"index.js","gitHead":"42dd77ad5712efec2e3bdc884e30af793db40e3a","scripts":{"pub-major":"npm version major --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-patch":"npm version patch --force && git push origin master && npm publish"},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"repository":{"url":"git+https://github.com/apitraffic/apitraffic-express.git","type":"git"},"_npmVersion":"8.19.3","description":"
Integrations ","directories":{},"_nodeVersion":"18.13.0","dependencies":{"@apitraffic/utilities":"^0.2.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_0.0.13_1721791675114_0.9138427417473882","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@apitraffic/express","version":"1.0.1","author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","_id":"@apitraffic/express@1.0.1","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"homepage":"https://github.com/apitraffic/apitraffic-express#readme","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"dist":{"shasum":"13f553ceabd8a5b7b84bd783c0870ce70f363a47","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-1.0.1.tgz","fileCount":656,"integrity":"sha512-uZnAVdmOHUwQ61hVIi0T0fASZrsbaA09LuXQYa7yUiajr8ViK+iYQDy24AIUc9mO7cx4qylvqW5Ap88Pe3VmnQ==","signatures":[{"sig":"MEQCIAQA5GrpYWvJlELz1TgMXlCvOj2Stsm3/8XE1JRA+STyAiBgoJYe9f7aKnnNOfuqQbbtb4KZXB2RCZ0Cf7LqmBOpcg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":4465568},"main":"index.js","gitHead":"417ae51bb9714c4c843c887b25d19b645c07762e","scripts":{"pub-major":"npm version major --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-patch":"npm version patch --force && git push origin master && npm publish"},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"repository":{"url":"git+https://github.com/apitraffic/apitraffic-express.git","type":"git"},"_npmVersion":"10.2.3","description":"Express plugin for sending request data to ApiTraffic.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"@apitraffic/utilities":"^1.0.13"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_1.0.1_1731667771535_0.7674682283897254","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@apitraffic/express","version":"1.0.2","author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","_id":"@apitraffic/express@1.0.2","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"homepage":"https://github.com/apitraffic/apitraffic-express#readme","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"dist":{"shasum":"f8cd34ae415e85882bf611774d0282a0bb7d8271","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-1.0.2.tgz","fileCount":7,"integrity":"sha512-Z/f2Py4kTsdAJyUZdA2tq8AYKMDsBN6g0fEmEyZirwtp9IsD4LLFstYV8QLY712uRUrw0seOEVRW6u9XMZofJw==","signatures":[{"sig":"MEQCIBpL8mtfix1gsZJKT21flh7wpVHPtL9FwtAbOUNv/j0YAiAHm8qlnSKkvQ4oVgj1jRZd5DM0Q8mQNQc++x8VuHF2uA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14840},"main":"index.js","gitHead":"610ae131b8cf0168ca3c9d7eb74c67586e19e878","scripts":{"pub-major":"npm version major --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-patch":"npm version patch --force && git push origin master && npm publish"},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"repository":{"url":"git+https://github.com/apitraffic/apitraffic-express.git","type":"git"},"_npmVersion":"10.7.0","description":"Express plugin for sending request data to ApiTraffic.","directories":{},"_nodeVersion":"22.2.0","dependencies":{"@apitraffic/utilities":"^1.0.13"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_1.0.2_1731928206085_0.5930299819086777","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@apitraffic/express","version":"1.0.3","author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","_id":"@apitraffic/express@1.0.3","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"homepage":"https://github.com/apitraffic/apitraffic-express#readme","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"dist":{"shasum":"68bafc6c19076be5379d200873a0be52f5748b22","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-1.0.3.tgz","fileCount":2459,"integrity":"sha512-y0KjDT398lkiaRwHvT6W8PC3B0QJ4aDHazV9YBdRNTgU2iGDO07G7IQ0yHvDd3Oj3k7cRp7aVixNvzSm8QylPA==","signatures":[{"sig":"MEUCIBKXu1jlRUo5XPjYev+Ek2lUuFdoC3BAPMvyvYt1PFKuAiEAzqBrhmzS8vLZ3umoVk89ZcIX9bLkSIPaREtH8FR0PCg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":27974641},"main":"index.js","gitHead":"02b8ef211d9967a7ccfbe4f9d143740b1720d861","scripts":{"pub-major":"npm version major --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-patch":"npm version patch --force && git push origin master && npm publish"},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"repository":{"url":"git+https://github.com/apitraffic/apitraffic-express.git","type":"git"},"_npmVersion":"6.14.4","description":"Express plugin for sending request data to ApiTraffic.","directories":{},"_nodeVersion":"12.16.2","dependencies":{"@apitraffic/utilities":"^1.0.13"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_1.0.3_1733997273945_0.4867682056686231","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@apitraffic/express","version":"1.0.4","author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","_id":"@apitraffic/express@1.0.4","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"homepage":"https://github.com/apitraffic/apitraffic-express#readme","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"dist":{"shasum":"709048df2fef8cf580fc9901595049607861528b","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-1.0.4.tgz","fileCount":2459,"integrity":"sha512-kWq4Gr3Gs1IA6btz8G4OVJ0uLzLR9Jo1W0F9ESWh2iPlVHhi9RNuKikqiVsRJdJXsvFJ7M5zphq46cSPcDl+9A==","signatures":[{"sig":"MEUCIQC5HeT+2twXAo2iyw2KSTRH43Oe2sg4T146ks8MzwXaHwIgdbqyrRzAUHgkHM2TTID/pLkCXG9j8YvgD6NTCmyyDaY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":27974586},"main":"index.js","gitHead":"9ddb89a7722c7674b822c5873fe0963d28fb8fb6","scripts":{"pub-major":"npm version major --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-patch":"npm version patch --force && git push origin master && npm publish"},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"repository":{"url":"git+https://github.com/apitraffic/apitraffic-express.git","type":"git"},"_npmVersion":"6.14.4","description":"Express plugin for sending request data to ApiTraffic.","directories":{},"_nodeVersion":"12.16.2","dependencies":{"@apitraffic/utilities":"^1.0.13"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_1.0.4_1733997742530_0.9645367208075877","host":"s3://npm-registry-packages-npm-production"}},"1.0.5":{"name":"@apitraffic/express","version":"1.0.5","keywords":["express","expressjs","workflows","integrations","logging"],"author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","_id":"@apitraffic/express@1.0.5","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"homepage":"https://github.com/apitraffic/apitraffic-express#readme","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"dist":{"shasum":"291e81c72c6b1a27559805368ff49c2fc74ca7c1","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-1.0.5.tgz","fileCount":2459,"integrity":"sha512-d/O6YIivenBnQOSF7fuq2PQIU8a/dRAl3ogsfV0Vix3JgmLeJc4rn5RWvZXOBcmzQEblpFKhSOmHPDRoo0ZFEQ==","signatures":[{"sig":"MEQCIHA8gsxw0c2NqJpLSzbEl3OcUZ68ug0YkDw1ap7FSObQAiAgu5u/N1ZShejno7LlgzfAEMZu2nNND/bv2pYT7BpVBw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":27974690},"main":"index.js","gitHead":"651ce8d5e13cc7e33f6644a3d3c40683ff57f669","scripts":{"pub-major":"npm version major --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-patch":"npm version patch --force && git push origin master && npm publish"},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"repository":{"url":"git+https://github.com/apitraffic/apitraffic-express.git","type":"git"},"_npmVersion":"6.14.4","description":"Express plugin for sending request data to ApiTraffic.","directories":{},"_nodeVersion":"12.16.2","dependencies":{"@apitraffic/utilities":"^1.0.13"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_1.0.5_1733998658612_0.3502071972581349","host":"s3://npm-registry-packages-npm-production"}},"1.0.6":{"name":"@apitraffic/express","version":"1.0.6","keywords":["express","expressjs","workflows","integrations","logging"],"author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","_id":"@apitraffic/express@1.0.6","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"homepage":"https://github.com/apitraffic/apitraffic-express#readme","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"dist":{"shasum":"5e8145d3aaddf4e21893e94746c012cefddb4543","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-1.0.6.tgz","fileCount":2459,"integrity":"sha512-FWB+xtvoMGx/8Vt5yCi0mBS4qnaxU8MkfNn8FQJPjlDVjmNykgbqxcurFnJgmUMnW6E0X5bvTic4Dsq5I+zkCg==","signatures":[{"sig":"MEUCIBf4uYdycITui8hm2xnlRm8tEqqlnh5kUhPF+d8r10SKAiEAmyRAoQmka75n12H9Af0KLGim+ut5WTReSwoOEA0nSUM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":27974690},"main":"index.js","gitHead":"c8e5312c51f004888409cc44bc60c5dbd9680778","scripts":{"pub-major":"npm version major --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-patch":"npm version patch --force && git push origin master && npm publish"},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"repository":{"url":"git+https://github.com/apitraffic/apitraffic-express.git","type":"git"},"_npmVersion":"6.14.4","description":"Express plugin for sending request data to ApiTraffic.","directories":{},"_nodeVersion":"12.16.2","dependencies":{"@apitraffic/utilities":"^1.0.13"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/express_1.0.6_1733998699835_0.23486957219895954","host":"s3://npm-registry-packages-npm-production"}},"1.0.7":{"name":"@apitraffic/express","version":"1.0.7","description":"Express plugin for sending request data to ApiTraffic.","main":"index.js","keywords":["express","expressjs","workflows","integrations","logging"],"scripts":{"pub-patch":"npm version patch --force && git push origin master && npm publish","pub-minor":"npm version minor --force && git push origin master && npm publish","pub-major":"npm version major --force && git push origin master && npm publish"},"dependencies":{"@apitraffic/utilities":"^1.0.13"},"repository":{"type":"git","url":"git+https://github.com/apitraffic/apitraffic-express.git"},"author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"homepage":"https://github.com/apitraffic/apitraffic-express#readme","gitHead":"340853b5e53036de4f1518bae2a8e1832fb46a43","_id":"@apitraffic/express@1.0.7","_nodeVersion":"12.16.2","_npmVersion":"6.14.4","dist":{"integrity":"sha512-l1TIdkF3UjrGgijQhzLrDQiD7/505zmMswZAPQsxM8EWvIyKBzomBYVoTQXzKzNcbJQjih1pa5oVmLpM14/MMA==","shasum":"6fb076b49316f9eed62b45570d53b9c9dc08a4dc","tarball":"https://registry.npmjs.org/@apitraffic/express/-/express-1.0.7.tgz","fileCount":8,"unpackedSize":20393,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCx1geGcVI5ug9GSkg4DbZ01neohatCzaUuiGzIpaFzlAIgJTZ+HYtWclrjSx0J2WQGzqs2tjN7kA+r2eJmZZLsxMQ="}]},"_npmUser":{"name":"jason-apitraffic","email":"jason@apitraffic.io"},"directories":{},"maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/express_1.0.7_1733998711270_0.53778958662687"},"_hasShrinkwrap":false}},"time":{"created":"2024-04-11T09:38:08.622Z","modified":"2024-12-12T10:18:31.723Z","0.0.1":"2024-04-11T09:38:08.788Z","0.0.3":"2024-04-11T10:04:05.590Z","0.0.5":"2024-04-18T09:16:35.617Z","0.0.7":"2024-04-19T12:20:36.135Z","0.0.8":"2024-04-28T10:51:55.440Z","0.0.10":"2024-07-24T02:54:11.246Z","0.0.11":"2024-07-24T03:04:49.755Z","0.0.12":"2024-07-24T03:16:38.110Z","0.0.13":"2024-07-24T03:27:55.374Z","1.0.1":"2024-11-15T10:49:31.842Z","1.0.2":"2024-11-18T11:10:06.258Z","1.0.3":"2024-12-12T09:54:34.249Z","1.0.4":"2024-12-12T10:02:22.785Z","1.0.5":"2024-12-12T10:17:39.032Z","1.0.6":"2024-12-12T10:18:20.313Z","1.0.7":"2024-12-12T10:18:31.543Z"},"bugs":{"url":"https://github.com/apitraffic/apitraffic-express/issues"},"author":{"name":"ApiTraffic.io","email":"sdk@apitraffic.io"},"license":"MIT","homepage":"https://github.com/apitraffic/apitraffic-express#readme","keywords":["express","expressjs","workflows","integrations","logging"],"repository":{"type":"git","url":"git+https://github.com/apitraffic/apitraffic-express.git"},"description":"Express plugin for sending request data to ApiTraffic.","maintainers":[{"name":"jason-apitraffic","email":"jason@apitraffic.io"}],"readme":"
\n
![](\"https://app.apitraffic.io/assets/images/apitraffic-logo.svg\")
\n
\n
\n
![](\"https://cdn.apitraffic.io/images/RepositoryMasthead.png\"/)
\n
\n
\n
\n
\n
\n
\n
\n\nApiTraffic helps engineering teams save development time so they can ship features faster. \n\n## Features\n\n*
API Monitoring & Observablity\n*
API Integrations (Workflow Engine)\n*
Supported Integrations\n\n## How ApiTraffic Works\n\nOnce you’ve integrated the ApiTraffic SDK into your application, each request/response will be sent to the ApiTraffic, processed, and will then appear within your desired bucket. \n\nFrom within your ApiTraffic account you will see real-time requests to your API, API analytics, the load size of the response, etc.\n\n> Visit
our knowledgebase for the complete documentation.\n\n## Security\n\n### Redacting Data\nData can be redacted either before it leaves your server or once it arrives to ApiTraffic for processing. Data redaction settings do not require any code changes as all configuration is done within your ApiTraffic account and pushed down to each connected server.\n\n
Learn more about redacting data. \n\n### Request Exclusions\nExclusions can be configured in cases where certain endpoints should not be logged. Like data redactions (above), no integration specific changes are required to exclude request that match a certain criteria. \n\n
Learn more about excluding requests. \n\n\n## Get Started\n\n1. Sign in to
ApiTraffic.\n2.
Setup the SDK for your application.\n\n### Install the SDK\n\n```sh\nnpm i @apitraffic/express --save\n```\n\n> **IMPORTANT**: Node 18+ required.\n\n### Add Code To Application\n```js\nconst express = require('express');\nconst apiTraffic = require('@apitraffic/express');\nconst app = express();\n\napp.use(apiTraffic.middleware());\n```\n\n### Configuration\n\nThere are a two different methods for configuring the ApiTraffic SDK:\n1. Parameters passed into the `apiTraffic.middleware()` function\n2. Setting values as environment variables\n\nThese methods are not mutually exclusive, if for whatever reason you need to set some as parameters and some as environment variables, it is ok they can be mixed.\n\n> If the same variable is set in both places, the parameters that are passed in will always supersede the environment variables. \n\n#### Options\n\n| Function Param | Environment Variable | Required | Type | Details |\n|---|---|:---:|---|---|\n| token | API_TRAFFIC_TOKEN | Yes | String | Ingest token provided from your ApiTraffic account. |\n| bucket | API_TRAFFIC_BUCKET | Yes | String | The bucket the data should be sent to when ingested. |\n| interceptOutbound | API_TRAFFIC_INTERCEPT_OUTBOUND | No | Boolean | If outbound requests should be intercepted. (Default: true) |\n| debug | API_TRAFFIC_DEBUG | No | String | Flag that toggles if the debug output should be added to the console. (Default: true) |\n\n## Tagging & Tracing\nAdditional context can be added to requests via the `tag()` and `trace()` functions provided by the ApiTraffic SDK.\n\n
![](\"https://cdn.prod.website-files.com/67308d108b18f8780bb38832/6732606f1b4f9d6c39888769_Tagging%20and%20Tracing.png\")
\n\n### Tagging\nTagging allows requests to be searchable by any number of tags that have been added to requests. For example, requests can be tagged by account or user ids which would then allow your team to view all API reqeusts for a specific account/person. There is no limit to the number of tags that can be added.\n\n```\n// include this in any file that needs tagging capabilities.\nconst apiTraffic = require('@apitraffic/express');\n\n// use the tag function.\napiTraffic.tag(\"key\", \"value\");\n```\n\n### Traces \nIt's console.log for production! Traces can easily be added to identify a specific code path or if data needs to be surfaced to help troubleshooting efforts.\n\n```\n// include this in any file that needs tracing capabilities.\nconst apiTraffic = require('@apitraffic/express');\n\n// use the trace function.\napiTraffic.trace(\"Whatever value that needs to be traced.\");\n```\n\n## Sample Application\n\nA working sample has been provided in this repository. [View the README](https://github.com/apitraffic/apitraffic-express/tree/master/examples/basic) for the sample application for details on how to run it.\n\n## Community\n\nTo get started: Star & watch [this repository](https://github.com/apitraffic/apitraffic-express) to stay updated on the latest changes.\n\nFollow us on our [Blog](https://apitraffic.io.blog) and on [X](https://x.com/apitraffic).\n\nChat with the ApiTraffic team and other memebers on [Discord](https://apitraffic.com/chat) and follow our tutorials and other videos on [YouTube](https://www.youtube.com/@ApiTraffic).\n\n[](https://apitraffic.io/chat)\n\n[](https://youtube.com/@apitraffic)\n\n[](https://x.com/apitraffic)\n\n### How to contribute\n\nHere are some ways you can help improve ApiTraffic:\n\n- Give [ApiTraffic a try](https://docs.apitraffic.io) and share your feedback to help make ApiTraffic even better for you. Feel free to reach out to us on [Discord](https://apitraffic.com/chat)!\n- Join our [Discord](https://apitraffic.com/chat) to connect with other members, share your experiences, and learn from one another.\n- Submit a pull request to any of our [open source repositories](https://github.com/apitraffic). Be sure to review the contribution guide in the repository for detailed instructions on how to get started. We’re excited to see your contributions!\n","readmeFilename":"README.md"}