مرجع عام

Exports

كل نقاط النهاية في هذه المجموعة. افتح أي واحدة لعرض معاملاتها ومثال عملي عليها.

7 نقاط النهاية

اعرض الصفحة بصيغة Markdown

Exports

GET /api/v1/exports List export jobs prm_exports_index

Jobs the caller owns, with their progress. A non-admin sees only jobs from their own manager subtree.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_exports_index View export jobs

المعاملات

المعامل	الوصف
`filter[status]` query · string	Job status.
`filter[format]` query · enum	csv or xlsx.
`filter[target_table]` query · string	One dataset key. The special value "reports" expands to every report dataset rather than matching exactly.

افتح المرجع الكامل

الاستجابة 200 OK

{
  "data": [
    {
      "id": 3312,
      "target_table": "users",
      "format": "xlsx",
      "status": "running",
      "processed": 4200,
      "total": 8120,
      "row_count": 0,
      "manager_id": 41,
      "created_at": "2026-09-20 09:10:00",
      "started_at": "2026-09-20 09:10:04"
    }
  ],
  "meta": { "page": 1, "page_size": 50, "total": 12, "has_next": false }
}

POST /api/v1/exports Queue an export prm_exports_create

Creates the job and returns immediately; a separate worker produces the file. The caller's authority scope is stamped onto the job server-side, so an export contains exactly what that manager's list view would show and nothing more.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_exports_create Create / delete export jobs
حد المعدل: t_heavy
مفتاح عدم التكرار: request_id

Exporting a table needs the permission to read it as well as the permission to export. The route's own gate is not enough, so a role with export rights but no subscriber-read right gets a 403 on target_table users. That is the check that stops an export from being a way around a list permission.

المعاملات

المعامل	الوصف
`target_table`مطلوب body · string	A dataset key from the datasets endpoint.
`format` body · enum	csv or xlsx. Defaults to xlsx.
`params` body · object	Dataset-specific filters, in the same shape that dataset's list endpoint accepts.
`request_id` body · string	Optional idempotency key. Blank stays blank and means no deduplication at all — supply your own if a retry must not queue a second job.

افتح المرجع الكامل

الاستجابة 202 Accepted

{
  "data": { "id": 3312 }
}

POST /api/v1/exports/bulk-delete Create / delete export jobs prm_exports_create

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_exports_create Create / delete export jobs
حد المعدل: t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

GET /api/v1/exports/datasets List exportable datasets prm_exports_index

Every table this build can export, with its key. target_table on the enqueue call must be one of these, and an unknown value is a 400. Static for the life of the release, so fetch it once and cache it.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_exports_index View export jobs

افتح المرجع الكامل

DELETE /api/v1/exports/{id} Delete an export job prm_exports_create

Removes the job and its artifact.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_exports_create Create / delete export jobs
حد المعدل: t_mutate

المعاملات

المعامل	الوصف
`id`مطلوب path · integer	Job id.

افتح المرجع الكامل

GET /api/v1/exports/{id} Poll one export job prm_exports_index

The job's current state and progress. Poll this until status reports the job is finished, then download.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_exports_index View export jobs

processed and total drive a progress bar; row_count is the final emitted count and stays 0 until the job finishes. A job that is not yours answers 404 rather than 403, so job ids are not enumerable across resellers.

المعاملات

المعامل	الوصف
`id`مطلوب path · integer	Job id.

افتح المرجع الكامل

GET /api/v1/exports/{id}/download Download an export artifact prm_exports_download

Streams the finished file. The ownership check runs again here, because the artifact itself can contain another reseller's card codes and balances.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_exports_download Download export files
حد المعدل: t_heavy

404 until the job has actually produced an artifact, which is indistinguishable from "no such job". Poll the job first rather than treating a download 404 as a permanent failure. This route is on the per-tenant heavy budget.

المعاملات

المعامل	الوصف
`id`مطلوب path · integer	Job id.

افتح المرجع الكامل

مكتوب لتقرأه الأدوات الآلية أيضًا

المرجع عام ولا يتطلب حسابًا، فتستطيع أداة لم تَرَ X-Radius من قبل أن تصل إلى أول استدعاء صحيح بنفسها.

/llms.txt: فهرس لكل صفحة، مع ملخّص من سطر واحد.
/llms-full.txt: المرجع كاملًا في ملف Markdown واحد، دون تنقّل يحتاج إلى زحف.
/openapi.json: ‏OpenAPI 3.1، مُولَّد من الموجّه الذي يخدم هذه النسخة.
/skill.md: ملف مهارة جاهز لمساعد آلي: المصادقة وشكل الاستجابة ورموز الأخطاء في صفحة واحدة.
<page-url>.md: أضف ‎.md إلى رابط أي صفحة في المرجع لتحصل على الصفحة نفسها بصيغة Markdown.
Accept: text/markdown: أرسل هذه الترويسة على الرابط المعتاد فتصلك الإجابة بصيغة Markdown بدلًا من الصفحة.

سلّم هذا السطر إلى مساعدك الآلي

اقرأ https://x-radius.com/llms.txt، ثم اجلب نقطة النهاية التي تحتاجها بصيغة Markdown بإضافة ‎.md إلى رابطها.

جرّبه على شبكتك.

50 مشترك لمدة 7 أيام، من غير ما تدفع حاجة.

جرّب ببلاش كلّمنا